Based on the information gathered, here is the draft for your README.md file for the EduCampus repository:
EduCampus is a chatbot platform designed to facilitate online learning and campus management. This repository contains the core components of the EduCampus chatbot system, including backend services, frontend applications, and deployment configurations.
EduCampus aims to provide a seamless online education experience through an intelligent chatbot, offering tools for both students and administrators. The platform includes features such as course management, student tracking, online assessments, and more.
EduCampus is built using the following technologies:
- Backend: Python, Flask, Groq, Langchain
- Frontend: Vue.js
- Markup: HTML
- Containerization: Docker
- Scripting: JavaScript
- Database: Qdrant
To set up EduCampus locally, follow these steps:
-
Clone the repository:
git clone https://github.com/parthpetkar/EduCampus.git cd EduCampus
-
Set up the backend:
# Create a virtual environment python -m venv venv source venv/bin/activate # On Windows, use `venv\Scripts\activate` # Install backend dependencies pip install -r requirements.txt
-
Set up the frontend:
cd frontend npm install npm run serve
-
Set up environmental variables:
Use .env.example
-
Set up database:
# Run the file ingest.py python ingest.py
-
Run the Docker container:
docker-compose up --build
Once the installation is complete, you can start using EduCampus by navigating to http://localhost:8080
in your web browser. Log in with your credentials to access the platform's features.
We welcome contributions from the community! To contribute to EduCampus, please follow these steps:
- Fork the repository.
- Create a new branch (
git checkout -b feature-branch
). - Make your changes and commit them (
git commit -m 'Add new feature'
). - Push to the branch (
git push origin feature-branch
). - Open a pull request.
Please make sure to follow our Code of Conduct and Contributing Guidelines.
EduCampus is licensed under the MIT License. See the LICENSE file for more information.