Welcome to the Online Chatbot based ticketing system, By Ministry Of Culture project! This guide will help you set up your environment and contribute to the project effectively.
For those who want to collaborate on GitHub, follow the steps below:
-
Download Git
- Download Git for Windows from your preferred browser.
- During installation, do not interfere with any customized options.
-
Fork the Repository
- Open GitHub and create a fork of this repository on your profile.
-
Clone the Repository
- Create a folder on your drive where you want to work on this repo.
- Go to the address bar, click on it, type
CMD
, and press Enter to open a command prompt window. - Type:
git clone <HTTPS-link-of-this-repo>
-
Open in VS Code
- Type:
code <HTTPS-link-of-this-repo>
- Then type:
code ./
- This will open a VS Code window with your directory connected.
- Type:
To run the provided Flask application, you need to install several Python modules. Here is a list of the required modules and how you can install them:
- Flask: This is the main framework used to create the web application.
pip install Flask
- NLTK: NLTK (Natural Language Toolkit)
pip install nltk
In your Python script or interpreter, run: python
import nltk
nltk.download('punkt')
By following these steps, you will have all the necessary modules installed to run your Flask application._
Now you can finally work on this code. Collaborate and add more features as much as you want. After your work is complete, do the following steps in order to upload it again to your forked repo:
-
Navigate to your project directory:
cd SIH.2024.ENIAC6
-
For those working on code:
cd chatbot
-
For frontend team:
- First execute the above line, then:
cd static # For CSS
cd templates # For HTML
-
Initialize Git (if not already initialized):
git init
-
Check status and stage changes:
git status
git add <file-name>
git status #Ensure file is staged
-
Commit and push changes:
git commit -m "Updated by Your Name"
git push
Congratulations! You have successfully completed all the steps! Happy collaborating!