This is a REST API that allows patients and doctors book appointments and manage availability respectively.
- 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
- Follow the documentation at: https://documenter.getpostman.com/view/11737108/TW6wJTvg
- Test the login endpoints with either a doctor or patient credential,
Doctor 1:
email: mudia@gmail.com
password: mudiareal
Doctor 2:
email: sandy@gmail.com
password: sandyreal
Patient 1:
email: markessien@gmail.com
password: patientonereal
Patient 2:
email: yinka@gmail.com
password: patienttworeal
- Test the other endpoints, as directed in the documentation, using the credentials above.
- Clone the Repository
- Create a .env file and use the supplied env variables.
- Run
docker-compose up --build - run migrations
docker-compose exec web python manage.py makemigrations - run
docker-compose exec web python manage.py migrate - run tests
docker-compose exec web python manage.py test - Using
docker-compose exec web python manage.py shell, enter into the shell and manually add a doctor and patient. - Test Login with doctor or patient email and password
- Hit the /calender endpoint to set available days and time as a doctor.
- Hit the /book-appointment endpoint as a Patient to book an appointment with a specific doctor.
https://documenter.getpostman.com/view/11737108/TW6wJTvg
https://cura-med-appointment.herokuapp.com/api
send an email to theresaobamwonyi@gmail.com if there are any questions.