This ticket explores creating a bash script specific to the CSXL site that would significantly help to simplify the developer experience developing the site - especially as this site continues to grow in size.
It also presents interesting tradeoffs for COMP 423, but makes understanding and working with the CLI easier.
Thoughts
Initial Goals
[ ] csxl start: Equivalent to running honcho start.
csxl start -b, csxl start backend: Starts the backend only.
csxl start -f, csxl start frontend: Starts the frontend only, equivalent to ng serve
[ ] csxl db: Contains different commands for interacting with the database
csxl db reset: Equivalent to python3 -m backend.script.reset_demo
csxl db reset -t, csxl database reset test: Equivalent to python3 -m backend.script.reset_testing
csxl db create: Equivalent to python3 -m backend.script.create_database
csxl db delete: Equivalent to python3 -m backend.script.delete_database
csxl db view: Opens relevant database viewer for the database
[ ] csxl test: Runs cd backend; pytest
csxl test -c, csxl test coverage: Runs the CSXL testing and determines coverage. Also automatically opens the index.html file that is generated.
[ ] csxl repl: Opens the repl script that @KrisJordan generated.
[ ] csxl setup: Completes the initial steps for setup listed in getting_started. Provides clearer error warnings when .env is missing, or auto-generate a blank .env file.
Stretch Goals
csxl deploy: Suite of commands relating to the deployment step to OKD. This might help immensely with setup in class - we can still make them go through many steps, such as setting up the pod, route, etc -- and explanations can be provided.
csxl db migration: Helper scripts related to generating database migrations with alembic.
This ticket explores creating a bash script specific to the CSXL site that would significantly help to simplify the developer experience developing the site - especially as this site continues to grow in size.
It also presents interesting tradeoffs for COMP 423, but makes understanding and working with the CLI easier.
Thoughts
Initial Goals
csxl start: Equivalent to runninghoncho start.csxl start -b,csxl start backend: Starts the backend only.csxl start -f,csxl start frontend: Starts the frontend only, equivalent tong servecsxl db: Contains different commands for interacting with the databasecsxl db reset: Equivalent topython3 -m backend.script.reset_democsxl db reset -t,csxl database reset test: Equivalent topython3 -m backend.script.reset_testingcsxl db create: Equivalent topython3 -m backend.script.create_databasecsxl db delete: Equivalent topython3 -m backend.script.delete_databasecsxl db view: Opens relevant database viewer for the databasecsxl test: Runscd backend; pytestcsxl test -c,csxl test coverage: Runs the CSXL testing and determines coverage. Also automatically opens theindex.htmlfile that is generated.csxl repl: Opens the repl script that @KrisJordan generated.csxl setup: Completes the initial steps for setup listed ingetting_started. Provides clearer error warnings when.envis missing, or auto-generate a blank.envfile.Stretch Goals
csxl deploy: Suite of commands relating to the deployment step to OKD. This might help immensely with setup in class - we can still make them go through many steps, such as setting up the pod, route, etc -- and explanations can be provided.csxl db migration: Helper scripts related to generating database migrations with alembic.