https://github.com/himanshumahajan138/sih_final
https://github.com/himanshumahajan138/sih_final
Last synced: 7 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/himanshumahajan138/sih_final
- Owner: himanshumahajan138
- License: mit
- Created: 2024-09-18T05:26:04.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2024-11-08T14:37:12.000Z (11 months ago)
- Last Synced: 2025-01-27T04:34:44.587Z (9 months ago)
- Language: JavaScript
- Size: 33.5 MB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# React-powered Rasa Chatbot
This project demonstrates how to create a chatbot using React for the frontend and Rasa for the backend. The backend is implemented in Python 3.8 using `virtualenv` for environment management.
## Prerequisites
- Node.js
- Python 3.8
- pip
- virtualenv
## Getting Started
### 1. Clone the Repository
```bash
git clone https://github.com/your-username/react-rasa-chatbot.git
cd react-rasa-chatbot
```
### 2. Set Up the Backend
#### 2.1. Create and Activate Virtual Environment
```bash
cd backend
python3.8 -m venv venv
source venv/bin/activate # On Windows use `venv\Scripts\activate`
```
#### 2.2. Install Required Packages
```bash
pip install -r requirements.txt
```
`requirements.txt` should include:
```
rasa==3.0.0
rasa-sdk==3.0.0
```
#### 2.3. Train the Rasa Model
```bash
rasa train
```
#### 2.4. Run the Rasa Server
```bash
rasa run
```
#### 2.5. (Optional) Run Rasa Action Server
If you have custom actions, start the action server:
```bash
rasa run actions
```
### 3. Set Up the Frontend
#### 3.1. Install Node.js Dependencies
```bash
cd ../frontend
npm install
```
#### 3.2. Start the React Development Server
```bash
npm start
```
### 4. Configuration
#### 4.1. Update Rasa Server URL
In the React app, update the Rasa server URL to match where your Rasa server is running. This is usually done in the `src/App.js` file or wherever the Rasa server endpoint is specified.
```javascript
const rasaServer = 'http://localhost:5005/webhooks/rest/webhook';
```
### 5. Project Structure
```
react-rasa-chatbot/
│
├── backend/
│ ├── actions/
│ ├── data/
│ ├── models/
│ ├── config.yml
│ ├── domain.yml
│ ├── endpoints.yml
│ └── requirements.txt
│
└── frontend/
├── public/
├── src/
├── package.json
└── README.md
```
### 6. Additional Commands
#### 6.1. Stop Running Servers
To stop the Rasa server and React development server, use `Ctrl+C` in their respective terminal windows.
#### 6.2. Deactivate Virtual Environment
```bash
deactivate
```
## Troubleshooting
- Ensure that both the Rasa and React servers are running on different ports.
- Verify that the Rasa server URL is correctly configured in the React app.
## Contributing
Feel free to contribute by submitting pull requests or issues to this repository. Ensure that your code adheres to the project's coding standards and includes tests where applicable.
## License
This project is licensed under the MIT License.