No description
- Python 97.7%
- HCL 1.1%
- HTML 0.7%
- Shell 0.4%
c69112af18
Some checks failed
Bumps [black](https://github.com/psf/black) from 23.1.0 to 24.3.0. - [Release notes](https://github.com/psf/black/releases) - [Changelog](https://github.com/psf/black/blob/main/CHANGES.md) - [Commits](https://github.com/psf/black/compare/23.1.0...24.3.0) --- updated-dependencies: - dependency-name: black dependency-type: direct:development ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> |
||
|---|---|---|
| .github/workflows | ||
| .vscode | ||
| bullsquid | ||
| docs | ||
| fe2 | ||
| fixtures | ||
| scripts | ||
| terraform | ||
| tests | ||
| .dockerignore | ||
| .env.example | ||
| .gitignore | ||
| api-compare.py | ||
| asgi.py | ||
| docker-compose.yaml | ||
| Dockerfile | ||
| piccolo_conf_test.py | ||
| poetry.lock | ||
| pyproject.toml | ||
| README.md | ||
bullsquid
Portal API backend project.
Prerequisites
Ensure Poetry 1.2+ is installed:
$ poetry --version
Poetry (version 1.2.0)
Ensure psql is installed:
$ psql --version
psql (PostgreSQL) 14.2
psql version does not matter as long as it's relatively recent.
Setup
The bootstrap script will do most of the work setting up the project.
scripts/bootstrap
The script will install dependencies and attempt to set up the database. If you don't have a PostgreSQL instance running on the default port, then the script will attempt to set one up for you with Docker. If you don't have Docker, this stage will fail and you will need to either set up PostgreSQL manually or install docker. Once you have done that, re-run the bootstrap script.
Running the API server
poetry run scripts/server
Running tests
poetry run scripts/test