LunaAI Chat-GPT

LunaAI is your AI assistant, JavaScript ChatGPT AI app using OpenAI ML model.

View Demo · Documentation · Report Bug · Request Feature

📔 Table of Contents

• About the Project
  • Folder Structure
  • Environment Variables
  • Tech Stack
• Getting Started
  • Installation
  • Run Locally
• Contributing
• License
• Contact
• Acknowledgements

🌟 About the Project

LunaAI is a VanillaJS ChatGPT AI app that resembles the ChatGPT app with the ability to ask the AI for help.

‼️ Folder Structure

The folder structure of LunaAI is separated into server-side and client-side.

lunaAI-ChatGPT/
|- client/
  |-- assets/
  |-- public/
  |-- index.html
  |-- package.json
  |-- script.js
  |-- style.css
|- server/
  |-- package.json
  |-- server.js
  |-- .env

Now, lets dive into the server and client folders.

client

index.html - style.css - script.js

Responsive layouts with CSS and elegant UI (User Interface) that resembles the ChatGPT app & communication with advanced GPT-3 model API.

server

server.js - .env

Node.js used for the server-side, VanillaJS code using OpenAI the newest Machine Learning model, handle events with JS.

🔑 Environment Variables

In order to use LunaAI you have to create your OpenAI api key here, to run this web app, you will need to add the following environment variable to your .env file

OPENAI_API_KEY

👾 Tech Stack

(back to top)

🧰 Getting Started

⚙️ Installation

Step 1:

Download or clone this repo by using the link below:

 https://github.com/ladunjexa/LunaAI-Chat-GPT

Step 2:

LunaAI using NPM (Node Package Manager), therefore, make sure that Node.js is installed by execute the following command in console:

  node -v

Step 3:

Go to client & server folders and execute the following command in console to get the required dependencies:

  npm install

Step 4:

Within the server-side folder create a file named .env and add the following environment variable:

  OPENAI_API_KEY=<YOUR_API_KEY>

🏃 Run Locally

Step 1:

Go to server folder and execute the following command in console to get the required dependencies:

  npm run server

Step 2:

Go to client folder and execute the following command in console to get the required dependencies:

  npm run dev

(back to top)

👋 Contributing

Contributions are always welcome!

See contributing.md for ways to get started.

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

⚠️ License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

🤝 Contact

Liron Abutbul - @lironabutbul6 - @ladunjexa

Project Link: https://github.com/ladunjexa/LunaAI-Chat-GPT

(back to top)

💎 Acknowledgements

This section used to mention useful resources and libraries that used in LunaAI ChatGPT

• OpenAI API
• Google Fonts
• #JSMastery

(back to top)