This is a basic boilerplate starter for a fullstack web project with Django as the server, PostgreSQL as the database and Next.js as the frontend.
- PostgreSQL used as the primary database.
- Superuser is already initialized with the credentials: Username-
admin
, Email-admin@admin.com
, Password-admin
- Integration with Django Rest Framework
- Integrated Djoser for user register/login/logout workflows.
- Used JWT for Authentication.
- API Documentation is configured using swagger.
- Containerized using Docker and managed using docker-compose.
- A typescripted Next.js client has been preinstalled and integrated with docker-compose.
- Added Chakra UI and Chakra icons in the frontend as a design and component library alongwith axios for making api calls.
To get a local copy of this template up and running on your machine, follow these simple steps.
- Docker
curl -fsSL https://get.docker.com -o get-docker.sh
sudo sh get-docker.sh
- Clone the repo
git clone https://github.com/akshat2602/django-nextjs-boilerplate.git
- Change the current directory to the template
cd django-nextjs-boilerplate
- Build the docker containers
docker-compose -f docker-compose.dev.yml build
for the dev containers anddocker-compose -f docker-compose.prod.yml build
for the prod containers - Run the docker containers
docker-compose -f docker-compose.dev.yml up
for the dev containers anddocker-compose -f docker-compose.prod.yml up
for the prod containers
API documentation is done using swagger. Visit /swagger
for API documentation.
See the open issues for a list of proposed features (and known issues).
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
Distributed under the MIT License. See LICENSE
for more information.
Akshat Sharma - akshatsharma2602@gmail.com Project Link: https://github.com/akshat2602/django-nextjs-boilerplate