7d8fe03b1a | ||
---|---|---|
.github | ||
CDC_Backend | ||
.gitignore | ||
README.md | ||
dev.env | ||
nginx.conf | ||
requirements.txt | ||
setup.sh |
README.md
CDC - Backend
Setup
- Download the Repository to your local machine
- Create a Virtual Environment in the CDC_Backend folder with this command below
python -m venv venv
- Activate the environment with this command
.\venv\Scripts\activate
- Install the dependencies
pip install -r requirements.txt
- Ensure that you have the PostgreSQL installed on your machine and is running on PORT 5432
- Make sure to give the correct database credentials in settings.py
Running the Application
- Activate the environment with this command.
.\venv\Scripts\activate
- Start the application by running this command (Run the command where manage.py is
located)
python manage.py runserver
Accessing the Admin Panel
- You can access the admin panel by running the server and opening http://localhost:8000/admin
- Run
python manage.py createsuperuser
to create a user to access the admin panel. - Set up the Username and Password
- You can log in and change the database values anytime.
Deploying
- Add the hosted domain name in
ALLOWED_HOSTS
in settings.py - Update the
CORS_ORIGIN_WHITELIST
list andCORS_ORIGIN_ALLOW_ALL
variable
API Reference
Check here for Api Reference
For Documentation with Postman Collection, click here