Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jayantbh authored Oct 23, 2024
1 parent 2c27c1d commit c5d6560
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -150,10 +150,13 @@ Make sure docker is running.
`./dev.sh` creates a `.env` file with required development environments and runs a CLI with does all the heavy lifting from tracking the container with `docker compose watch` to providing you with logs from different services.\
The usage is as follows:
```bash
./local-setup.sh # Optional; See note
./dev.sh
```
You may update the `env.example` and set `ENVIRONMENT=prod` to run it in production setup.\
Further if any changes are required to be made to ports, you may update the `docker-compose.yml` file, accordingly.

**Note** about `local-setup.sh`: While you don't need to run this script, it takes care of any local environment setup for automatic linting without which your PRs may fail the linter check.
4. **Access the Application**:
Once the project is running, access the application through your web browser at http://localhost:3333.
Further, other services can be accessed at:
Expand Down

0 comments on commit c5d6560

Please sign in to comment.