200010030
/
cdc-placement-website-backend
mirror of https://github.com/CDC-IITDH/cdc-placement-website-backend
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
147 Commits 64 Branches 0 Tags 22 MiB
Python 81.2%
HTML 18.2%
Shell 0.4%
Batchfile 0.2%
Go to file
dependabot[bot] 76d2ffe584
Bump mccabe from 0.6.1 to 0.7.0 
Bumps [mccabe](https://github.com/pycqa/mccabe) from 0.6.1 to 0.7.0.
- [Release notes](https://github.com/pycqa/mccabe/releases)
- [Commits](https://github.com/pycqa/mccabe/compare/0.6.1...0.7.0)

---
updated-dependencies:
- dependency-name: mccabe
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
 		2022-04-10 17:55:46 +00:00
.github Delete codeql-analysis.yml 2022-04-10 23:13:21 +05:30
CDC_Backend added recaptcha verification (#79) 2022-04-10 23:12:02 +05:30
.gitignore Initial Commit 2021-10-15 20:47:23 +05:30
README.md Update README.md 2021-12-03 01:15:04 +05:30
dev.env added recaptcha verification (#79) 2022-04-10 23:12:02 +05:30
nginx.conf Added Few More Apis and corrected a view 2021-12-12 19:14:27 +05:30
requirements.txt Bump mccabe from 0.6.1 to 0.7.0 2022-04-10 17:55:46 +00:00
setup.sh Added Few More Apis and corrected a view 2021-12-12 19:14:27 +05:30

README.md

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

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 is located)
    python manage.py runserver

Accessing the Admin Panel

  1. You can access the admin panel by running the server and opening http://localhost:8000/admin
  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
  2. Update the CORS_ORIGIN_WHITELIST list and CORS_ORIGIN_ALLOW_ALL variable

API Reference

Check here for Api Reference

For Documentation with Postman Collection, click here