gpthub-backend

This project is a backend implementation of a Chat GPT mirror (Monolithic Architecture)

Technologies used:

• Golang, PostgreSQL
• REST, Swagger UI
• JWT Authentication
• OpenAI

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these example steps.

Installation

1. Clone the repo

   git clone https://github.com/HubCreators/gpthub-backend

2. Set environment variables in application root (.env)

   DB_PASSWORD=<postgres password>
   PASSWORD_SALT=<password salt>
   JWT_SIGNING_KEY=<JWT secret key>
   
   OPEN_API_KEY=<OpenAI secret key>
   
   GIN_MODE=debug

3. Compile and build the project

   make

(back to top)

Usage

After launch, go to the address in the browser http://localhost:8080/docs/index.html

Here you can register a user and get a JWT access token.
Next, add the Authorization header with the value Bearer <your access token> on every request (use Authorization button)

Authorized users can send requests to GPT chat by sending requests to /api/v1/chat.

At the moment, only the ability to communicate with the ChatGPT is implemented, but in the future it is planned to add template prompts that add more context to the chat request.

(back to top)

Roadmap

• Implement ChatGPT request method with context
• Add logic for working with the mail service
• Add logic for admin "panel"

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

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)

Contact

Alexey Fedoseev - @fedoseev_alexey - rv1nnie@yandex.ru

Project Link: gpthub-backend

(back to top)