Welcome to Chatbot H2S, a React-based chatbot application built as part of the Hack2Skill Building Chatbot in React Challenge. This project leverages cutting-edge libraries and tools to deliver a sleek and interactive chatbot experience. 🚀
Experience the chatbot live here: Chatbot H2S
- Interactive Chat Interface: Built with React for a dynamic and seamless user experience.
- Markdown Rendering: Supports rich-text responses using the
react-markdown
library. - API Integration: Fetches data dynamically using
axios
and the Gemini API. - Tailwind CSS Styling: Modern and responsive design powered by Tailwind CSS.
- React: Core framework for building the chatbot interface.
- Tailwind CSS: For sleek, responsive, and utility-first styling.
- react-markdown: To render Markdown-formatted chatbot responses.
- axios: Simplifies API requests and data fetching.
- Gemini API: Powers the chatbot's conversational capabilities.
- Vercel: Effortless deployment for a live production experience.
Follow these steps to set up the project locally:
-
Clone the Repository:
git clone https://github.com/deepakcode21/chatbot-H2S.git cd chatbot-H2S
-
Install Dependencies:
npm install
-
Configure Environment Variables:
- Create a
.env
file in the root directory. - Add your Gemini API key or other necessary environment variables:
REACT_APP_GEMINI_API_KEY=your_api_key_here
- Create a
-
Run the Development Server:
npm start
Open http://localhost:3000 in your browser to see the app.
Here's an overview of the project structure:
chatbot-H2S/
├── public/ # Static assets
├── src/ # Main source code
│ ├── components/ # React components
├── .env # Environment variables
├── package.json # Dependencies and scripts
└── README.md # Project documentation
Contributions are welcome! If you have ideas to enhance the chatbot or find any bugs, feel free to open an issue or submit a pull request.
- Fork the repository.
- Create a new branch (
git checkout -b feature/YourFeature
). - Commit your changes (
git commit -m 'Add YourFeature'
). - Push to the branch (
git push origin feature/YourFeature
). - Open a pull request.
This project was a great opportunity to:
- Dive deeper into React's capabilities for building interactive UIs.
- Explore Tailwind CSS for rapid and efficient styling.
- Work with APIs using
axios
to fetch and handle data. - Deploy the app on Vercel for a seamless live experience.
- Live Application: https://chatbot-h2-s.vercel.app/
- GitHub Repository: https://github.com/deepakcode21/chatbot-H2S
- Hackathon Challenge: Hack2Skill Event
This project is licensed under the MIT License. See the LICENSE file for details.
Developed with ❤️ by Deepak.