API Service backing client interfaces
- Python 3.9 : Base programming language for development
- Bash Scripting : Create convenient script for easy development experience
- PostgreSQL : Application relational databases for development, staging and production environments
- Django Framework : Development framework used for the application
- Django Rest Framework : Provides API development tools for easy API development
- Github Actions : Continuous Integration and Deployment
- Docker Engine and Docker Compose : Containerization of the application and services orchestration
Getting started with this project is very simple, all you need is to have Git and Docker Engine installed on your machine. Then open up your terminal and run this command git clone https://github.com/decadevs/recyclepay-api.git to clone the project repository.
Change directory into the project folder cd recyclepay-api and build the base python image used for the project that was specified in dockerfile by running docker build . Note the dot (.) at end of the command.
Spin up other services needed for the project that are specified in docker-compose.yml file by running the command docker-compose up. At this moment, your project should be up and running with a warning that you have unapplied migrations.
Open up another terminal and run this command docker-compose exec api python project/manage.py makemigrations for creating new migrations based on the models defined and also run docker compose exec api python project/manage.py migrate to apply migrations.
In summary, these are the lists of commands to run in listed order, to start up the project.
1. git clone https://github.com/decadevs/recyclepay-api.git
2. cd recyclepay-api
3. docker build .
4. docker-compose up
5. docker-compose exec api python project/manage.py makemigrations
6. docker-compose exec api python project/manage.py migrate
Currently, truthy tests has been provided in each of the application defined in the project, before running the tests with the following command make sure that your api service is up and running.
docker-compose exec api python project/manage.py test
The MIT License - Copyright (c) 2020 - Present, Decagon Institute. https://decagonhq.com/
|
Akorede Olawole |
Olusola Afolayan |
Samson Kitigo |
Nwokocha Maruche |
Msendoo Chile |
|
Mark Eke |
Ifeanyi Omeata |
Jonathan Kolawole |
Josiah Akpaetuk |
|
|
Hakeem Oyerinmade - Lead |
Rafihatu Oziohu Bello - Lead |
Adenike Awofeso - Lead |