https://github.com/akshat2602/django-nextjs-boilerplate

A starter template for building a fullstack web app with Django, django-rest-framework, Next.js(Typescripted) using docker with PostgreSQL as the primary DB.
https://github.com/akshat2602/django-nextjs-boilerplate

django django-rest-framework docker docker-compose nextjs postgresql typescript

Last synced: 30 days ago
JSON representation

A starter template for building a fullstack web app with Django, django-rest-framework, Next.js(Typescripted) using docker with PostgreSQL as the primary DB.

• Host: GitHub
• URL: https://github.com/akshat2602/django-nextjs-boilerplate
• Owner: akshat2602
• License: mit
• Created: 2022-01-15T15:32:18.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2024-01-29T02:01:48.000Z (11 months ago)
• Last Synced: 2024-01-29T03:28:27.967Z (11 months ago)
• Topics: django, django-rest-framework, docker, docker-compose, nextjs, postgresql, typescript
• Language: Python
• Homepage:
• Size: 203 KB
• Stars: 32
• Watchers: 2
• Forks: 10
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-boilerplate - Github
• awesome-boilerplate - Github

README

        

# Django-Next.js-Boilerplate!

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.

  

  

  

## About the template 

-   PostgreSQL used as the primary database.

-   Superuser is already initialized with the credentials: Username- `admin`, Email- `[email protected]`, 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.

## Getting Started

To get a local copy of this template up and running on your machine, follow these simple steps.

### Prerequisites

- Docker

`curl -fsSL https://get.docker.com -o get-docker.sh`

`sudo sh get-docker.sh`

### Installation

- 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 and `docker-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 and `docker-compose -f docker-compose.prod.yml up` for the prod containers

## API Documentation

API documentation is done using swagger. Visit `/swagger` for API documentation.

## Technologies used

 

  

 

 

  



## Contributing

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**.

1.  Fork the Project

2.  Create your Feature Branch (`git checkout -b feature/AmazingFeature`)

3.  Commit your Changes (`git commit -m 'Add some AmazingFeature'`)

4.  Push to the Branch (`git push origin feature/AmazingFeature`)

5.  Open a Pull Request

## License

Distributed under the MIT License. See `LICENSE` for more information.

## Contact

Akshat Sharma - [[email protected]](mailto:[email protected])

Project Link: [https://github.com/akshat2602/django-nextjs-boilerplate](https://github.com/akshat2602/django-nextjs-boilerplate)