This is an API for Flora site to store art works
If you want just to run this project (without contributing) you can use Docker. For this you need the following packages:
dockerdocker-compose
And, If they're already installed you need to create .env file with the
following content:
DJANGO_SECRET_KEY="2$6#ajqdl8n+-6qs6f#))pivv&hku5rj37iy$y@swp6$v)7+9v"
DJANGO_ENVIRONMENT="testing"
And build the docker image
$ docker-compose build
Up this image:
$ docker-compose up -d
Apply all migrations (only once after building)
docker-compose run web python manage.py migrate
If you want to create a superuser account you can run the following command:
$ docker-compose run web python manage.py createsuperuser
And go on http://127.0.0.1:8000/
If you want to contribute this project you need to install the following:
Run the dependencies installation
$ poetry install
Add the django secret key into .env file:
DJANGO_SECRET_KEY="2$6#ajqdl8n+-6qs6f#))pivv&hku5rj37iy$y@swp6$v)7+9v"
Run the poetry shell and exports environment variables:
$ poetry shell
$ export $(cat .env | xargs)
Run the migrations:
$ python manage.py migrate
Create a superuser account:
$ python manage.py createsuperuser
Run the server:
$ python manage.py runserver
And go on http://127.0.0.1:8000/
If you want to run the unit tests you need to do the following command:
$ python manage.py test projects categories
If you want to run the functional tests you need to do the following command:
$ python manage.py test functional_tests
Documentation for API is available on http://127.0.0.1:8000/redoc/ on running project.
- Artemowkin (Backend API) - https://github.com/artemowkin/
- steelWinds (Frontend App) - https://github.com/steelWinds/
This project is licensed under the GPL-3.0 License - see the LICENSE file for details.