Files
Open-Assistant/scripts/backend-development
Andrew Maguire 0f607c7a28 export and auto-commit docs/docs/api/openapi.json as part of test-api-contract workflow (#719)
- copies that openapi.json file to docs/docs/api/openapi.json as part of start-mock-server.sh.
- adds a step to the end of the test-api-contract workflow that just auto-commits changes to the docs/docs/api/openapi.json file.
- excludes docs/docs/api/openapi.json from pre-commit since its already been formatted by jq.
2023-01-14 22:40:33 +00:00
..
2023-01-01 20:57:35 +00:00

Backend Development Setup

In root directory, run docker compose up backend-dev --build --attach-dependencies to start a database. The default settings are already configured to connect to the database at localhost:5432.

Make sure you have all requirements installed. You can do this by running pip install -r requirements.txt inside the backend folder and pip install -e . inside the oasst-shared folder. Then, run the backend using the run-local.sh script. This will start the backend server at http://localhost:8080.