Skip to content

alexberce/openai-nestjs-template

Repository files navigation

OpenAI ChatGPT Microservice

This template makes it easy to quickly get started building NestJs microservices that utilize the power of OpenAI and ChatGPT, by providing a preconfigured set of modules and services.

  • REST API with MongoDB support
  • Swagger documentation, Joi validation
  • Folder structure, code samples and best practices
  • Crafted for Docker environments (Dockerfile support and environment variables)

License

1. Requirements

Before starting, make sure you have the minimum requirements on your workstation.

  • An up-to-date release of NodeJS and Yarn (or npm)
  • A MongoDb database (you may use the provided docker-compose file to create one).

2. Setup

2.1. Install the dependencies.

$ yarn

2.2. Make a copy of the example environment variables file.

On Linux systems:

$ cp .env.example .env

On Windows:

$ copy .env.example .env

2.3. Configure your environment variables in the newly created .env file.

For a standard development configuration, you can use the default values and configure only the OpenAi and MongoDb variables.

You can find your OpenAI API key here and the organization id here

3. Run the app

# development
$ yarn run start

# watch mode
$ yarn run start:dev

# production mode
$ yarn run start:prod

You should now be able to access the swagger docs for the API at http://localhost:3001

4. Roadmap

  • List Models
  • Text Completion
  • Code Completion
  • Image Generation
  • Edit Image
  • Model Fine Tuning
  • Content Moderation

5. Stay in touch