https://github.com/redflag-bugs/ncert-bot
https://github.com/redflag-bugs/ncert-bot
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/redflag-bugs/ncert-bot
- Owner: REDFLAG-bugs
- Created: 2024-07-09T04:23:16.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-05T08:01:02.000Z (almost 2 years ago)
- Last Synced: 2024-08-05T09:59:27.289Z (almost 2 years ago)
- Language: Jupyter Notebook
- Size: 15 MB
- Stars: 3
- Watchers: 1
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# NCERT-BOT
## Overview
`NCERT-BOT` is a repository focused on integrating and processing educational content from the NCERT curriculum. This project aims to create a bot that can assist with accessing and querying NCERT books and related educational resources.
# Repository Structure
```
NCERT-BOT/
│
├── BOOKS/
│ └── English_xii/
│
├── RAG/
│ ├── chatbot.py
│ ├── pdf_to_vectordb.py
│ └── requirements.txt
│
├── Results/
│
├── src/
│ ├── selenium_extracts/
│ ├── youtube_extracts/
│ ├── __init__.py
│ └── beautifulsoup.py
│
├── extraction.py
│
├── .gitignore
├── README.md
└── requirements.txt
```
# Installation
### 1. Clone the Repository
Clone the repository to your local machine:
```bash
git clone https://github.com/REDFLAG-bugs/NCERT-BOT.git
cd NCERT-BOT
```
## 2. Set Up a Virtual Environment (Optional)
If you want to use a virtual environment, run the following commands:
```bash
python -m venv venv
source venv/bin/activate # On Windows, use `venv\Scripts\activate`
conda create --name myenv # conda environment
conda activate myenv # activate conda env
```
## 3. Install Dependencies
Install the necessary dependencies:
```bash
pip install -r requirements.txt
```
## Usage
To run the extraction script:
```bash
python extraction.py
```
This script will process the data according to the logic defined in extraction.py.
## Contributing
We welcome contributions to improve the project. Please follow these steps:
### 1. Fork the repository.
Create a new branch:
```bash
git checkout -b feature-branch
```
### 2. Commit your changes:
```bash
git commit -am 'Add new feature'
```
### 3. Push to the branch:
```bash
git push origin feature-branch
```
### 4. Open a Pull Request.
## Contact
For any questions or issues, please contact the contributors:
[REDFLAG-bugs](https://github.com/REDFLAG-bugs)
[anshumangit2411](https://github.com/anshumangit2411)
[saswattulo](https://github.com/saswattulo)
[akansh30](https://github.com/akansh30)
[yashy04](https://github.com/yashy04)