- Python 3.9 : Base programming language for development
- PostgreSQL : Application relational databasefor the production environment
- Django Framework : Development framework used for the application
- Django Rest Framework : Provides API development tools for easy API development
- GithubAction : Continuous Integration and Deployment
An Api that allows User to create, update and delete employees data
Getting started with this project is very simple, all you need is to have Git installed on your machine. Then open up your terminal and run this command git clone https://github.com/Remi288/employeeApi.git
to clone the project repository.
Change directory into the project folder cd EMPLOYEES_Api
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 python manage.py makemigrations
for creating new migrations based on the models defined and also run api python 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/Remi288/employeeApi.git
2. cd EMPLOYEES_Api
3. python manage.py makemigrations
4. python manage.py migrate
The following setting is in the environment variable
1. SECRET_KEY=
2. JWT_SECRET_KEY=
5. DEBUG=True
python manage.py test
- Swagger : Swagger Documentation
- App Hosted URL : Heroku