jfoyarzo / chatgpt-backend

Storyteller AI is a full-stack app that uses the OpenAI API to enable a chatbot that answers questions in the form of a story, using analogies to explain topics.

📗 Table of Contents

• 📗 Table of Contents
• 📖 Storyteller AI
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
  • 👥 Author
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • 📝 License

📖 Storyteller AI

Storyteller AI is a full-stack app that uses the OpenAI API to enable a chatbot that answers questions in the form of a story, using analogies to explain topics. It consists of a single endpoint created with Express on the backend that sends the request to the API and a frontend built with React. This project was built as an exercise to integrate the OpenAI API with a full-stack app. You can see the frontend repository here.

🛠 Built With

Tech Stack

Client

• React

Backend

• Node.js
• Express.js

API

• OpenAI API

Key Features

• You can ask questions in the chatbox.
• Uses chat-gpt ver 3.5
• The chatbot responds by telling a story.

(back to top)

💻 Getting Started

To get a local copy up and running, follow these steps.

Prerequisites

To run this project you need:

• Git
• Npm/Node.js

Setup

Clone this repository to your desired folder using this command:

git clone [email protected]:jfoyarzo/chatgpt-backend.git

cd chatgpt-backend

Install

Install this project's dependencies using:

npm install

Since this project uses the OpenAI API, you need to supply your corresponding credentials by creating a .env file in the root of the app. You can use the provided .env.example file as a guide. If you don't have an API key yet, you can get one by signing up on the OpenAI API Website.

Usage

To run the project, execute the following command from the root folder of the app:

npm start

this will start the backend on http://localhost:8000/

👥 Author

👤 Felipe Oyarzo

• GitHub: @jfoyarzo
• LinkedIn: LinkedIn

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project please consider giving it a star!

(back to top)

🙏 Acknowledgments

This project was built following the How to Build an AI-Powered ChatBot Tutorial by Njoku Samson Ebere.

(back to top)

📝 License

This project is MIT licensed.

(back to top)