This repository contains a project that combines Django, Django REST Framework, Next.js to create a web application with a robust backend and a dynamic frontend.
The project is organized into two main folders:
backend
: Contains the Django application responsible for handling API requests and database interactions.frontend
: Contains the React application built using Next.js, providing a modern and efficient development experience for the frontend.
The backend is built using Django and Django REST Framework, providing a RESTful API to communicate with the frontend. The key features of the backend include:
- API endpoints to manage various resources, such as users, data models, and more.
- Integration with a database (e.g., PostgreSQL, SQLite) to store and retrieve data.
- Authentication and authorization mechanisms to secure API endpoints.
- Custom views, serializers, and models to tailor the API to your project's needs.
-
Navigate to the
backend
folder:cd backend
-
Create a Python Virtual Environment (Optional, but recommended):
Create and activate a virtual environment to isolate project dependencies.
On macOS and Linux:
python3 -m venv venv source venv/bin/activate
On Windows:
pip install virtualenv virtualenv venv ./venv/Scripts/Activate.ps1
-
Install the required Python packages:
pip install -r requirements.txt
-
Run database migrations:
python manage.py makemigrations python manage.py migrate
-
Start the Django development server:
python manage.py runserver
-
Use
http://localhost:8000
as the API base URL.
The frontend is built using Next Js. The frontend offers a user-friendly interface to interact with the API provided by the Django backend.
- Navigate to the
frontend
folder:cd frontend
- Install the required Node packages:
yarn install | npm install ( yarn recommended )
- Start the development server:
yarn dev | npm run dev ( yarn recommended )
- Navigate to
http://localhost:3000
to view the frontend.
For detailed information about the available API endpoints and their usage, refer to the Post API Documentation.
Sayak Saha 💻 |
Riddhick Dalal 💻 |
Shiwangi Kumari 🚇 |
Stefan Anevski 📖 |
- Django: https://www.djangoproject.com/
- Django REST Framework: https://www.django-rest-framework.org/
- NEXT.js: https://nextjs.org/
- Tailwind CSS https://tailwindcss.com/
- Shadcn UI: https://ui.shadcn.com/
- Formik: https://formik.org/