Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sralloza/chore-management-api
Chore Management API
https://github.com/sralloza/chore-management-api
Last synced: about 2 months ago
JSON representation
Chore Management API
- Host: GitHub
- URL: https://github.com/sralloza/chore-management-api
- Owner: sralloza
- Created: 2022-06-25T16:11:29.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-01-10T16:39:26.000Z (about 2 years ago)
- Last Synced: 2023-03-09T04:32:30.570Z (almost 2 years ago)
- Language: Gherkin
- Homepage: https://sralloza.github.io/chore-management-api/
- Size: 1.13 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Chore Management API
API to manage chores in a shared flat.
## Development
The API is written in python using FastAPI. The first implementation was written in node.js using express. The incomplete node.js version can be found in the commit fa0e9bf7ec4d0b8fa9e7cd10117684551b2afb21.
### Testing
#### Run all tests
The `run-tests.sh` script will start all containers, run the tests and stop the containers. With the flag `--keep-up=true` it will keep the containers up until CTRL-C is pressed.
#### Run some tests
You must have the containers up and running before running the tests (`docker-compose up -d`).
```shell
# Launch all tests
behave
# Launch tests of a specific API
behave -t api.chore-types
# Launch tests of a specific endpoint
behave -t getChoreTypes
# Launch authorization tests
behave -t authorization
# Launch other common tests
behave -t common
```
## Deploy
Docker images are provided in [dockerhub](https://hub.docker.com/r/sralloza/chore-management-api).
**Note: the database must be mariadb or mysql.**
### Configuration
Configuration is done by setting environment variables.
#### Required
- **_ADMIN_API_KEY_**: master administration API key.
- **_APPLICATION_SECRET_**: secret key for the application. Used to sign JWT tokens.
#### Optional
- **_DATABASE_HOST_**: database host. Defaults to `localhost`.
- **_DATABASE_NAME_**: database name. Defaults to `chore-management`.
- **_DATABASE_PASSWORD_**: database password. Defaults to `root`.
- **_DATABASE_PORT_**: database port. Defaults to `3306`.
- **_DATABASE_USERNAME_**: database username. Defaults to `root`.
- **_ENABLE_DB_CLEANUP_**: when set to `true`, the scheduler will be enabled and will run periodically some cleanup database tasks. Defaults to `true`.
- **_IS_PRODUCTION_**: when set to `true`, the application will run in production mode (for example, documentation will not be available). Defaults to `true` in the docker application and to `false` in the python application.
- **_REDIS_HOST_**: redis host. Defaults to `localhost`.
- **_REDIS_PORT_**: redis port. Defaults to `6379`.
#### Optional only for docker
These variables are only used when running the docker image. The docker entrypoint script will manage them.
- **_CREATE_DATABASE_**: if set to `true`, it will try to create the database each time the container starts.
- **_RUN_MIGRATIONS_**: run migrations on start. Defaults to `true`, meaning by default migrations are executed on start.
- **_WAIT_FOR_IT_ADDRESS_**: comma separated addresses to wait for. For example, to wait for a database to be ready, set it to `database:3306`.