https://github.com/viraj5903/cosmochatui
CosmoChat UI is the frontend application enabling users to engage in chat sessions with an AI chatbot powered by OpenAI's language model. It offers a seamless platform for users to interact with the chatbot, ask questions, and receive responses naturally. Key features include activity tracking, session ending, and session management.
https://github.com/viraj5903/cosmochatui
chatbot material-ui openai-api reactjs
Last synced: about 1 year ago
JSON representation
CosmoChat UI is the frontend application enabling users to engage in chat sessions with an AI chatbot powered by OpenAI's language model. It offers a seamless platform for users to interact with the chatbot, ask questions, and receive responses naturally. Key features include activity tracking, session ending, and session management.
- Host: GitHub
- URL: https://github.com/viraj5903/cosmochatui
- Owner: Viraj5903
- Created: 2024-06-10T02:57:20.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-06-19T18:31:22.000Z (about 2 years ago)
- Last Synced: 2025-02-15T06:31:20.198Z (over 1 year ago)
- Topics: chatbot, material-ui, openai-api, reactjs
- Language: JavaScript
- Homepage:
- Size: 132 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# CosmoChat UI
## Overview:
CosmoChat UI is the frontend application that enables users to engage in chat sessions with an AI chatbot powered by OpenAI's language model. The primary objective is to offer a seamless platform for users to interact with the chatbot, ask questions, and receive responses naturally. It incorporates features such as activity tracking, session ending, and session management.
## Technologies and Tools used:
* React.js
* Material UI
* Axios
* OpenAI
## Available Scripts
In the project directory, we can run:
1. `npm start`:\
Runs the react app in the development mode.
Open [http://localhost:3000](http://localhost:3000) to view it in our browser.\
The page will reload when we make changes.
1. `node ./server.js`:\
Runs the server.js file which start server that will store the chats sessions in `data/db.json` file in json format.
Server will be running on port 3500.
## Project Setup Instructions:
To set up CosmoChatUI, follow these steps:
1. **Clone the repository to your local machine**.
- To clone run:
```
git clone https://github.com/Viraj5903/CosmoChatUI.git
```
2. **Ensure you have Node.js and npm installed:**
- Download and install [Node.js](https://nodejs.org/en) if you haven't already.
3. **Navigate to the root directory of the project**:
- To navigate to the root directory of the project, run:
```
cd CosmoChatUI
```
4. **Install Dependencies**:
- To install required dependencies, run:
```
npm install
```
5. **Add your OpenAI API key**:
- Get your OpenAI API key from [OpenAI](https://platform.openai.com/api-keys)
- Create a .env file in the root directory of the project.
- Add the following line to the .env file, replacing {YOUR_API_KEY} with your actual API key:
```
REACT_APP_OPENAI_API_KEY={YOUR_API_KEY}
```
6. **Run Server**:
- To run the server that store that chats session inside the `data/db.json` file in json format. Run:
```
node ./server.js
```
7. **Start React Application**:
- To start react application. Run:
```
npm start
```