Skip to Main Content

Environment variables

Environment variables are needed in the .env file to allow the application to run correctly. .env.example file has an example template you can use to get started. However, you will need to follow these steps to get your GitHub OAuth environment variables. Please note that if you are working in Gitpod and wish to access authenticated pages, you will need to complete these steps each time with the URL Gitpod generates for your dev environment as localhost will not work. To avoid this, you may choose to work in Docker which only requires this setup once.

If you want to login, you will need to create a GitHub OAuth app on GitHub and add the credentials to the .env file, which are highlighted in bold in the table below. Details on how to create the GitHub OAuth app are in the next section below. If you do not want to login, you can skip this step and the app will still work.

BIODROP_MONGO_CONNECTION_STRINGmongodb://localhost:27017/biodroptrueDatabase connection string
NEXT_PUBLIC_BASE_URLhttp://localhost:3000trueHosting URL: localhost:3000 or Gitpod url
GITHUB_IDabcedfghil12345trueGitHub OAuth ID
GITHUB_SECRETa1b2c3e4f5e6trueGitHub OAuth Secret
NEXTAUTH_URLhttp://localhost:3000trueThe url you visit for the app, localhost:3000 or Gitpod url
NEXTAUTH_SECRETafsfdsafadsftrueNext Auth Secret, this can be any random characters
GITHUB_API_TOKENdjsbjsjacdnkfalseGithub Personal Access Token to increase the read rate limit on GitHub's API (requires minimal permissions)
ADMIN_USERSeddiejaoude,SaraJaoude,_test-admin-userfalseWhich users can access the admin section

GitHub OAuth (required if you want to login)

  1. Go to your profile settings
  2. Then Developer settings down the bottom left
  3. Click New OAuth app and fill in the form details
Form fieldvalue
Application nameBioDrop local
Homepage URL
Application descriptionBioDrop allows you to connect with your audience using a single link.
Authorization callback URLhttp://localhost:3000/api/auth/callback/github

Then use the generated Client ID and Client Secret in the .env.

Full details on GitHub docs

GitHub Personal Access Token

  1. Go to your profile settings
  2. Then Developer settings down the bottom left
  3. Click Personal Access Token and generate a PAT

Full details on GitHub docs