https://github.com/samyc2002/cdc-placement-website-backend
https://github.com/samyc2002/cdc-placement-website-backend
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/samyc2002/cdc-placement-website-backend
- Owner: Samyc2002
- Created: 2021-10-25T15:45:54.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-11-28T13:12:59.000Z (over 3 years ago)
- Last Synced: 2025-02-10T03:13:36.572Z (4 months ago)
- Language: Python
- Size: 140 KB
- Stars: 0
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# CDC - Backend
---
### Setup
1. Download the Repository to your local machine
2. Create a Virtual Environment in the [CDC_Backend](./) folder with this command below
`python -m venv venv`
3. Activate the environment with this command
`.\venv\Scripts\activate`
4. Install the dependencies
`pip install -r requirements.txt `
5. Ensure that you have the PostgreSQL installed on your machine and is running on PORT **5432**
6. Make sure to give the correct database credentials in [settings.py](./CDC_Backend/CDC_Backend/settings.py)
### Running the Application
1. Activate the environment with this command.
`.\venv\Scripts\activate`
2. Start the application by running this command (_Run the command where [manage.py](./CDC_Backend/manage.py) is
located_)
` python manage.py runserver`
### Accessing the Admin Panel
1. You can access the admin panel by running the server and opening
2. Run `python manage.py createsuperuser` to create a user to access the admin panel.
3. Set up the Username and Password
4. You can log in and change the database values anytime.
### Deploying
1. Add the hosted domain name in `ALLOWED_HOSTS` in [settings.py](./CDC_Backend/CDC_Backend/settings.py)
2. Update the `CORS_ORIGIN_WHITELIST` list and `CORS_ORIGIN_ALLOW_ALL` variable
### API Reference
Check [here](./CDC_Backend/README.md) for Api Reference