Skip to content
This repository has been archived by the owner on Jan 10, 2023. It is now read-only.

Commit

Permalink
Updating README for new YAML configuration.
Browse files Browse the repository at this point in the history
  • Loading branch information
dschissler committed Nov 29, 2014
1 parent eebe9f9 commit aa07d14
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,8 +93,8 @@ Go to File - Preferences... in Poedit and add a new parser in the Parsers tab:

## Development Usage:

1. Copy `./etc/templates/dev_config.json` to `./etc/dev.json`
2. Configure `./etc/dev.json` for local database password
1. Copy `./etc/templates/dev_config.yaml` to `./etc/dev.yaml`
2. Configure `./etc/dev.yaml` for local database password
3. Create a Webird user with `./dev/webird.php useradd`
4. Run server processes: `./dev/webird.php [server]` and wait until webpack-dev-server has finished building
5. Visit http://dev.webird.io
Expand All @@ -104,8 +104,8 @@ If you see the local host file not configured page then add `127.0.0.1 dev.webir
## Distribution Usage:

#### Create dist environment:
1. Copy `./etc/templates/dist_config.json` to `./etc/dist.json`
2. Configure `./etc/dist.json` to override settings from `./etc/dist_defaults.json`. These two files will be merged to form `./dist/etc/config.json`.
1. Copy `./etc/templates/dist_config.yaml` to `./etc/dist.yaml`
2. Configure `./etc/dist.yaml` to override settings from `./etc/dist_defaults.yaml`. These two files will be merged to form `./dist/etc/config.yaml`.
3. Create the dist environment: `./dev/webird.php build`
4. Visit https://dist.webird.io

Expand All @@ -118,7 +118,7 @@ At this point you may use Poedit to open any .po file in `./app/locale`. Click
1. Generate nginx configuration with : `./webird.php nginx` (and save with `>` redirection and enable it in nginx).
2. Import database schema located at `./etc/schema.sql`
3. Run server processes: `./webird.php`
4. If something is wrong modify `./config.json` and repeated steps 1-3. To make changes more permanent for dist releases you may go back and modify the original `./etc/dist.json` file and then rebuild the dist environment.
4. If something is wrong modify `./config.yaml` and repeated steps 1-3. To make changes more permanent for dist releases you may go back and modify the original `./etc/dist.yaml` file and then rebuild the dist environment.

The nginx configuration must be rebuilt if the distribution environment directory is moved or renamed. It is recommended to use the `./webird.php nginx` command to rebuild the configuration instead of manually editing the generated nginx configuration. If more advanced custom settings are required it is recommended to first modify the `./etc/template/dist_nginx` file and then rebuild the dist environment.

Expand All @@ -139,7 +139,7 @@ The nginx configuration must be rebuilt if the distribution environment director
│ ├── config/
│ └── modules/
└── webpack
├── config.litcoffee (you can make this .json, .js or .coffee)
├── config.litcoffee (you can make this .json, .yaml, .js or .coffee)
├── commons (common code to be run by multiple entry points)
├── entries (specific code entry points)
└── modules (custom commonjs modules)
Expand Down

0 comments on commit aa07d14

Please sign in to comment.