This repository contains a project that combines Django, Django REST Framework, React, and Vite 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 Vite, 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:
Navigate to the backend
folder:
cd backend
Setup the environment variables:
Rename the .env.example
to .env
and update all the env variables.
EMAIL_HOST_USER
is your gmail.EMAIL_HOST_PASSWORD
will be the App Password in your gmail. Refer this doc to create your app password.DATABASE_URL
is typically a external Postgres db URL hosted on cloud. You can create a free one on Render.core/settings.py
and comment out line 95-97Create 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 React and Vite, providing fast development and hot module replacement for efficient code changes. The frontend offers a user-friendly interface to interact with the API provided by the Django backend.
frontend
folder:
cd frontend
npm install
npm run dev
http://localhost:5173
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 π |
Harith π» |