Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/rubydevi/chatgpt-ruby

A simple AI-human chat server that'll mimic ChatGPT in every way.
https://github.com/rubydevi/chatgpt-ruby

Last synced: about 5 hours ago
JSON representation

A simple AI-human chat server that'll mimic ChatGPT in every way.

Awesome Lists containing this project

README

        

# πŸ“— Table of Contents

- [πŸ“– About the Project](#about-project)
- [πŸš€ Front End](#back-end)
- [πŸ›  Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [πŸš€ Live Demo](#live-demo)

- [πŸ’» Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [πŸ‘₯ Authors](#authors)
- [πŸ”­ Future Features](#future-features)
- [🀝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [πŸ™ Acknowledgements](#acknowledgements)
- [❓ FAQ](#faq)
- [πŸ“ License](#license)

# πŸ“– ChatGPT Rails API

This app is a very simple app where API endpoints for user registration and login is exposed aling with other engpoints for new messages and conversation between user and AI.

## πŸš€ Frontend

[Click here to see the front end](https://github.com/rubydevi/chatgpt-react)

## πŸ›  Built With

### Tech Stack

### Key Features

> User Login and Sigup

> Create new conversation.

> Create new messages in a conversation.

> Secure user login.

> Secure user authentication

(back to top)

## πŸš€ Live Demo

> Live Demo of this application:

- [Live Demo Link](https://ai-chat-782z.onrender.com)

(back to top)

## πŸ’» Getting Started

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

### Prerequisites

In order to run this project you need:

### Setup

Clone this repository to your desired folder:

```sh
git clone https://github.com/rubydevi/chatgpt-ruby.git
```

### Install

Install this project with:

```sh
cd my-project
bundle install
```

### Setup .ENV

1. create an env file by running the following command

```sh
touch .env
```

Or create the .env file manually at the root of the application.

2. open databse.yml file and Find the default: &default section in the file and copy the credentials into your .env file:

```sh
DATABASE_USERNAME=your_username
DATABASE_PASSWORD=your_password
```

### Usage

To run the project, you will need to execute:

```sh
rails db:create

rails db:migrate

rails db:seed

rails s
```

(back to top)

## πŸ‘₯ Author

πŸ‘€ Chongtham Ruby Devi

- GitHub: [@rubydevi](https://github.com/rubydevi)
- LinkedIn: [@Chongtham Ruby Devi](https://www.linkedin.com/in/chongtham-bhoomika/)

(back to top)

## πŸ”­ Future Features

> API Documentation

> Google and Github Login

(back to top)

## 🀝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/rubydevi/chatgpt-ruby/issues).

(back to top)

## Show your support 🌟

Thank you for taking the time to explore this project! Your support means a lot to me. If you find my project valuable and would like to contribute, here is one way you can support me:

- Star the project ⭐️: Show your appreciation by starring this GitHub repository. It helps increase visibility and lets others know that the project is well-received.

- Fork the project 🍴 🎣: If you're interested in making improvements or adding new features, feel free to fork the project. You can work on your own version and even submit pull requests to suggest changes.

- Share with others πŸ—ΊοΈ: Spread the word about this project. Share it on social media, mention it in relevant forums or communities, or recommend it to colleagues and friends who might find it useful.

(back to top)

## πŸ™ Acknowledgments

I would like to express my sincere gratitude to [Anarchy](https://anarchy.ai/welcome/why_anarchy), for providing this project idea. It has truly helped me enhance my skills in areas I hadn't previously identified as needing improvement.

(back to top)

## ❓ FAQ

- **Question_1**

Do I have to use the vs code specifically?

- Answer_1

You can use any one of your favortite or prefered editors

(back to top)

## πŸ“ License

[![MIT License](https://img.shields.io/badge/License-MIT-green.svg)](./LICENSE)

(back to top)