Go to file
karthik mv 30cf743683 Merge pull request #121 from CDC-IITDH/updating-readme
Updated README.md in CDC_BACKEND directory
2022-06-01 23:22:47 +05:30
CDC_Backend Merge pull request #121 from CDC-IITDH/updating-readme 2022-06-01 23:22:47 +05:30
.gitignore Merge branch 'main' of https://github.com/CDC-IITDH/cdc-placement-website-backend 2022-05-19 19:18:05 +05:30
README.md Reformatted Code and Optimized Imports 2022-05-02 17:16:56 +05:30
nginx.conf Few Changes Done 2022-05-01 14:56:46 +05:30
requirements.txt Bump pyjwt from 2.3.0 to 2.4.0 (#113) 2022-05-28 20:09:08 +05:30
setup.sh Added Few More Apis and corrected a view 2021-12-12 19:14:27 +05:30

README.md

python# 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

Starting the Email Server

Run the following command to start the email backend process
python manage.py process_tasks

API Reference

Check here for Api Reference

For Documentation with Postman Collection, click here