fabianferno / the-racoon-app

An Issue/Project Tracker that helps ease software delivery. Submit, Track & Resolve bugs in a flash.

the-racoon-app

Project setup

Use npm to install the project dependencies:

npm install

Configuration

Configure credentials

The project needs to be configured with your Auth0 Domain, Client ID and Client Secret for the authentication flow to work.

To do this, first copy .env.local.example into a new file in the same folder called .env.local, and replace the values with your own Auth0 application credentials (see more info about loading environmental variables in Next.js):

# A long secret value used to encrypt the session cookie
AUTH0_SECRET='LONG_RANDOM_VALUE'
# The base url of your application
AUTH0_BASE_URL='http://localhost:3000'
# The url of your Auth0 tenant domain
AUTH0_ISSUER_BASE_URL='https://YOUR_AUTH0_DOMAIN.auth0.com'
# Your Auth0 application's Client ID
AUTH0_CLIENT_ID='YOUR_AUTH0_CLIENT_ID'
# Your Auth0 application's Client Secret
AUTH0_CLIENT_SECRET='YOUR_AUTH0_CLIENT_SECRET'
# Your Auth0 API's Identifier 
# OMIT if you do not want to use the API part of the sample
AUTH0_AUDIENCE='YOUR_AUTH0_API_IDENTIFIER'
# The permissions your app is asking for
# OMIT if you do not want to use the API part of the sample
AUTH0_SCOPE='openid profile email read:shows'

Note: Make sure you replace AUTH0_SECRET with your own secret (you can generate a suitable string using openssl rand -hex 32 on the command line).

Run the sample

Compile and hot-reload for development

This compiles and serves the Next.js app and starts the API server on port 3001.

npm run dev

Deployment

Compiles and minifies for production

npm run build

Docker build

To build and run the Docker image, run exec.sh, or exec.ps1 on Windows.

Run the unit tests

npm run test

Run the integration tests

npm run test:integration

License

This project is licensed under the MIT license. See the LICENSE file for more info.