From 9bc37cfcb8359a747f4112e05de7b8fb83fc773f Mon Sep 17 00:00:00 2001 From: xnought Date: Fri, 17 Nov 2023 16:43:15 -0800 Subject: [PATCH] docs: refresh packages docs --- docs/run.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/run.md b/docs/run.md index 62d7437b..42d83414 100644 --- a/docs/run.md +++ b/docs/run.md @@ -14,10 +14,12 @@ sh run.sh |---|---| | `start` | 👉 Starts/runs the docker container | | `stop` | 👉 Stops the docker container | +| `refresh_packages` | 👉 Updates or adds new packages in frontend and backend, needs to be run every time you add a new package locally | | `restart` | Stops, then Starts the docker container | -| `hard_restart` | 👉 Builds the docker container from scratch and starts it, do this if you're having errors | +| `soft_restart` | 👉 Updates or adds packages, reloads the init sql, and restarts. Use this if you're getting errors. | +| `hard_restart` | 👉 Builds the docker container from scratch and starts it, do this if you're having errors that even `soft_restart` can't fix | | `gen_api` | 👉 Creates/Generates the frontend api code based on the backend endpoints | -| `reload_init_sql` | Reload/change the schema in [`init.sql`](../backend/init.sql)| +| `reload_init_sql` | 👉 When you change the the schema in [`init.sql`](../backend/init.sql), this reloads it, otherwise your changes won't show up in the docker | | `sql_dump` | Dumps the current db contents and schema into [`backups/`](../backend/backups/).| | `psql` | Opens up a direct terminal into the database to execute SQL commands live | | `test` | Runs all unit tests |