Skip to content

Latest commit

 

History

History
61 lines (50 loc) · 1.88 KB

README.md

File metadata and controls

61 lines (50 loc) · 1.88 KB
Raw

IITR_Chatbot_backend

Setup

  • Prerequisites:

    • Python 3
    • pip
    • default-libmysqlclient-dev

  • Clone this repository.

  • Set up a virtual environment.

python3 -m venv chatbot_env
  • Activate the virtual environment.
source chatbot_env/bin/activate
  • Navigate inside the cloned repository and install the required dependencies using the command:
pip install -r requirements.txt
  • Navigate to /chatbot_backend and create a file named .env and store the following credentials inside it
SECRET_KEY=your-secret-key
  • Navigate back to the base directory for the app where manage.py file is located and make the database migrations using following command:
python manage.py migrate
  • Start the backend server:
python mange.py runserver

API Structure

  • To access all the links with their category and subcategory info:
http://127.0.0.1:8000/chatbot
  • To access a specific link through its category, subcategory and name:
http://127.0.0.1:8000/chatbot/category/sub-category/name

For commit messages

Please start your commits with these prefixes for better understanding among collaborators, based on the type of commit:

feat: (addition of a new feature)
rfac: (refactoring the code: optimization/ different logic of existing code - output doesn't change, just the way of execution changes)
docs: (documenting the code, be it readme, or extra comments)
bfix: (bug fixing)
chor: (chore - beautifying code, indents, spaces, camelcasing, changing variable names to have an appropriate meaning)
ptch: (patches - small changes in code, mainly UI, for example color of a button, incrasing size of tet, etc etc)
conf: (configurational settings - changing directory structure, updating gitignore, add libraries, changing manifest etc)