Skip to content

Latest commit

 

History

History
79 lines (58 loc) · 2.19 KB

README.md

File metadata and controls

79 lines (58 loc) · 2.19 KB

ChatBot Application With Flask

This is a chatbot application built using Flask and MongoDB. Please note that this is a practice project for a college assignment, so we have focused on delivering a simple and efficient solution.

Requirements

Before setting up the application, ensure that you have the following requirements installed on your system:

  • Python (version 3.6 or higher)
  • pip (Python package installer)
  • Virtualenv (tool to create isolated Python environments)

Installation

Use the package manager pip to install python package.

  1. Clone the repository to your local machine.
git clone git@github.com:ujjawalpoudel/chatbot-with-flask-python.git
  1. Navigate to the project directory.
cd chatbot-with-flask-python  
  1. Create a virtual environment. Use the version number of python installed on your computer. check it using python --version
python3.11 -m venv chatbot_env 
  1. Activate the virtual environment.

    a. For mac:

    source chatbot_env/bin/activate

    b. For windows:

    chatbot_env\Scripts\activate.bat
  2. Install the required Python packages.

pip install -r requirements.txt

Running the Application

  1. Activate the virtual environment.

    a. For mac:

    source chatbot_env/bin/activate

    b. For windows:

    chatbot_env\Scripts\activate.bat
  2. Start the Flask development server.

python main.py
  1. Access the application in a web browser by navigating to http://localhost:5000.

API Documentation

For detailed API documentation, please refer to the Postman Collection.

Conclusion

This concludes the setup readme for the Flask application. If you encounter any issues during setup or usage, please get in touch with the project maintainer for assistance.

Contributing

Pull requests are welcome. For significant changes, please open an issue first to discuss what you would like to change.