Skip to content

Commit

Permalink
Update run.md
Browse files Browse the repository at this point in the history
  • Loading branch information
xnought authored May 22, 2024
1 parent 07bdb40 commit 39e63af
Showing 1 changed file with 1 addition and 6 deletions.
7 changes: 1 addition & 6 deletions docs/run.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,6 @@

The [`run.sh`](../run.sh) contains all the commands to run the backend, frontend, restart the containers, and more.

> [!IMPORTANT]
> Use the `-p` flag right after the `<cmd>` for production mode. This will change the default [`docker-compose.yml`](../docker-compose.yml) to [`docker-compose-prod.yml`](../docker-compose-prod.yml) in the [`run.sh`](../run.sh).
> For example you can run `./run.sh start -p` to build in production mode. Or to source the schema with the init.sql you can do `./run.sh sql_reload -p backend/init.sql`.
You can easily call a function defined in the [`run.sh`](../run.sh) by calling

```bash
Expand All @@ -28,10 +24,9 @@ Commands from [`run.sh`](../run.sh) listed below with descriptions for how to us
### Build commands


| ./run.sh `<cmd>` | what it does |
|---|---|
| `gen_api` | Creates/Generates the frontend api code based on the FastAPI endpoints [`frontend/src/lib/backend/openapi/`](../frontend/src/lib/backend/openapi/). Note that the docker needs to be running. |
| `gen_api` | Creates/Generates the frontend api code based on the FastAPI endpoints [`frontend/src/lib/backend/openapi/`](../frontend/src/lib/openapi/). Note that the docker needs to be running. |
| `start` | Starts/runs the docker container where edits to the backend or frontend will hot reload |
| `stop` | Stops the docker container |
| `restart` | Stops then starts the docker container. |
Expand Down

0 comments on commit 39e63af

Please sign in to comment.