ChatGPT PromptOptimizer

[Description]

State of Code

Backend

Frontend

Configuration

Environment Variables for Run

ChatGPT API

• OPENAI_API_KEY
  • used to get access to OpenAI API
  • you can disable API access if set to disabled
• OPENAI_API_ORGANIZATION
  • used to define a target for billing
  • you can disable API access if set to disabled

Mongo DB

• MONGO_DB_URI
  • URL of used MongoDB
• MONGO_DB_NAME
  • name of used database on DB server above
  • to separate databases of different run configurations / scenarios

OAuth2 / User Management

• OAUTH_GITHUB_CLIENT_ID
  • client id from OAuth2 app in GitHub
• OAUTH_GITHUB_CLIENT_SECRET
  • client secret from OAuth2 app in GitHub
• OAUTH_GOOGLE_CLIENT_ID
  • client id from OAuth2 app in Google
• OAUTH_GOOGLE_CLIENT_SECRET
  • client secret from OAuth2 app in Google
• INITIAL_ADMIN
  • user id of first admin: github{ ID of GitHub Account }
  • to have an admin if user database is initially empty

GitHub Secrets

• DOCKERHUB_PASSWORD
  • used for pushing build docker image to docker in workflow "Deploy to render.com" (.github/workflows/CD_DockerRender.yml)
• RENDER_DEPLOY_HOOK
  • used for redeployment of docker image in workflow "Deploy to render.com" (.github/workflows/CD_DockerRender.yml)
• SONAR_TOKEN
  • used for code linting of Sonar Cloud (.github/workflows/SonarCloud_backend.yml, .github/workflows/SonarCloud_frontend.yml)

GitHub Variables

• DOCKERHUB_USERNAME
  • used for pushing build docker image to docker in workflow "Deploy to render.com" (.github/workflows/CD_DockerRender.yml)
• DOCKER_IMAGE_NAME
  • used to build name of docker image: { DOCKERHUB_USERNAME }/{ DOCKER_IMAGE_NAME }:latest