Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/shivananand/restroworks-chatbot-personal-project

This project was created to showcase my full-stack development skills to the Restroworks team. It demonstrates my ability to integrate third-party AI services, build dynamic web applications, and deploy complex projects on cloud platforms.
https://github.com/shivananand/restroworks-chatbot-personal-project

ejs expressjs google-generative-ai nodejs render

Last synced: 3 months ago
JSON representation

Host: GitHub
URL: https://github.com/shivananand/restroworks-chatbot-personal-project
Owner: SHIVANANAND
Created: 2024-08-18T13:05:31.000Z (4 months ago)
Default Branch: main
Last Pushed: 2024-08-18T14:30:39.000Z (4 months ago)
Last Synced: 2024-10-12T00:05:14.488Z (3 months ago)
Topics: ejs, expressjs, google-generative-ai, nodejs, render
Language: CSS
Homepage: https://restroworks-chatbot.onrender.com
Size: 120 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# Restroworks Chatbot

This project is a full-stack application created to demonstrate my skills in building and deploying a chatbot using Node.js, Express, and EJS, integrated with Google Generative AI. The chatbot is designed to provide information about Restroworks and how their solutions can help businesses in the restaurant industry.

## Project Overview

### Features
- **Chatbot Integration**: Utilizes Google Generative AI to power the chatbot, providing detailed and accurate responses related to Restroworks' offerings.
- **User Interaction**: The chatbot engages users by understanding their business needs and suggesting relevant solutions.
- **EJS Templating**: The frontend is rendered using EJS, allowing for dynamic content based on user interactions.
- **Express Server**: The backend is built with Express, handling routing, API requests, and serving static files.

### Technologies Used
- **Node.js**: Backend runtime environment.
- **Express**: Web framework for Node.js.
- **EJS**: Embedded JavaScript templating.
- **Google Generative AI**: Provides the intelligence behind the chatbot.
- **Render**: Hosting platform for the deployed application.

## Project Structure
```
.
├── public
│ ├── assets
│ │ ├── behavior.js
│ │ ├── style.css
│ │ └── webpageStyle.css
│ └── views
│ ├── index.ejs
│ └── webpage.ejs
├── .env
├── .gitignore
├── imports-and-load-chatbot-model.js
├── index.js
├── package.json
├── post-request-for-chat-bot.js
└── README.md
```

## Installation and Setup

1. **Clone the repository**:
```bash
git clone https://github.com/yourusername/restroworks-chatbot.git
```

2. **Install dependencies**:
```bash
cd restroworks-chatbot
npm install
```

3. **Set up environment variables**:
- Create a `.env` file in the root directory.
- Add your Google Generative AI API key:
```
GEMINI_API_KEY=your_google_api_key_here
```

4. **Run the application**:
```bash
npm start
```
The application will run on `http://localhost:3000`.

5. **Access the chatbot**:
- Visit `http://localhost:3000` to interact with the chatbot.

## Deployment

This project is deployed on Render and can be accessed at the following link:

[https://restroworks-chatbot.onrender.com](https://restroworks-chatbot.onrender.com)

## Purpose