This is a simple Quotes API project that allows users to create and read quotes. It uses Docker and Docker Compose for a consistent and easy development. It also includes Postgres for the database and the Django Rest Framework for developing the APIs. The project is written in Python and follows best practices for Django development.
- Python 3.10: Base programming language for development
- 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
- Docker Engine and Docker Compose : Containerization of the application and services orchestration
-
Clone the Repository
-
create a .env file with the variables in the .env.example file
cp env.example .env
-
Run
make build-dev- Running the above command for the first time will download all docker-images and third party packages needed for the app.
- NB: This will take several minutes for the first build
-
Run
make up-dev- Running the above command will Start up the following Servers:
- Postgres Server --> http://localhost:5433
- Django Development Server --> http://localhost:8000
- Running the above command will Start up the following Servers:
-
Run
make down-devto stop the servers -
Run
make testto run tests -
Other commands can be found in the Makefile
Make sure that all the above servers are running before you start exploring the project.