Skip to content

Latest commit

 

History

History
60 lines (43 loc) · 3.21 KB

run.md

File metadata and controls

60 lines (43 loc) · 3.21 KB
Raw

run.sh

The run.sh contains all the commands to run the backend, frontend, restart the containers, and more.

You can easily call a function defined in the run.sh by calling

./ run.sh <cmd>

or for production mode

./run.sh <cmd> -p

Command reference

Commands from run.sh listed below with descriptions for how to use it.

Important

Use the -p flag right after the <cmd> for production mode. This will change the default docker-compose.yml to docker-compose-prod.yml in the run.sh. For example you can run ./run.sh start -p to build in production mode. Or to load from a backup with production you can do ./run.sh reload_from_backup -p backups/v0.0.2.

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/. 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.
restart_from_scratch Nukes the docker and rebuilds everything from scratch.
refresh_packages Updates or adds new packages in frontend and backend, needs to be run every time you add a new package locally

Database commands

Note that for production mode, if there is a second argument like <filename> it follows the -p flag. For example ./run.sh reload_from_backup -p backups/v0.0.2. If you're running in default dev mode, ignore this. Also try to save the backups under the backups/ folder and make sure to choose a unique name if you're backing up stuff.

./run.sh <cmd> what it does
psql Opens up a direct terminal into the database to execute SQL commands live
backup <backupname> Dumps the sql schema and data + copies all the protein .pdb files into a new directory of name <backupname>
reload_from_backup <backupname> Deletes all the current database reloads from the backupname generated from the backup command above.
sql_reload <filename> Deletes all the database and sources the <filename>. Example: ./run.sh sql_reload backups/v0.0.2/dump.sql.
sql_source <filename> Sources/executes the <filename> on the db. Example: ./run.sh sql_source backups/v0.0.2/dump.sql.
sql_delete Deletes all database contents.
sql_dump <filname> Dumps the current db contents and schema to <filename>. Example: ./run.sh sql_dump example.sql will dump the db to example.sql.
sql_date_backup Dumps the current db contents and schema to backend/backups with the current timestamp as filename.

Addons

./runsh <cmd> what it does
add_foldseek installs foldseek onto the docker container via wget
remove_foldseek deletes foldseek from the docker container
add_tmalign installs tm align onto the docker container via wget
remove_tmalign deletes tmalign from the docker container