gitpoap-backend

Running Locally with docker-compose

Example .env:

APP_NAME=gitpoap-backend

JWT_SECRET=yoyo

AWS_PROFILE=docker-agent

NODE_ENV=local

DATABASE_URL="postgresql://postgres:foobar88@localhost:5432"

POAP_API_URL="http://localhost:4004"
POAP_AUTH_URL="http://localhost:4005"
POAP_CLIENT_ID="a good client id"
POAP_CLIENT_SECRET="super secret!"
POAP_API_KEY="key to the city"

GITHUB_URL="https://github.com"
GITHUB_API_URL="https://api.github.com"

GITHUB_APP_CLIENT_ID="foobar"
GITHUB_APP_CLIENT_SECRET="whoville"
GITHUB_APP_REDIRECT_URL="http://localhost:3000/login"

REDIS_URL="redis://gitpoap-redis:ICanHazASecurePassword@localhost:6379"
MAILCHIMP_API_KEY="fake-key-us14"
SENTRY_DSN="https://test.ingest.sentry.io/12345"
POSTMARK_SERVER_TOKEN="fake-token"
SLACK_TOKEN="fake-slack-token"
DISCORD_CLIENT_ID="1123545252342342"
DISCORD_CLIENT_SECRET="x0_t_3adf3gadfasdf_faefes"
DISCORD_REDIRECT_URL="http://localhost:3000/settings?type=discord"

Entire Backend

To run all of the services (fake-poap-api, fake-poap-auth, db, redis, and server) locally (with seeded data), we can run:

yarn docker:server

Everything but the Server

To run background services (fake-poap-api, fake-poap-auth, db, and redis), we can run:

yarn docker:background

then you can easily work on the backend API while making code changes locally (which will restart after any changes) via:

# First time to migrate and seed the DB:
yarn dev:first-time
# After we've already seeded the DB but want to restart the server for some reason:
yarn dev

Changing the Logging Level

You can change the logging level by specifying one option (debug, info, warn, error) to the --level option on the command line. For example:

yarn run dev --level debug

Testing

Unit Testing

Unit tests are stored in the __tests__/unit folder. The structure of the inside of this folder should mirror that in src/.

To run the unit tests:

yarn test:unit

Please keep all common mocks used in tests within __mocks__. The structure of the inside of this folder should mirror that in src/.

Integration Testing

Integration tests are stored in the __tests__/integration folder. The structure of the inside of this folder should mirror that in src/.

To run the integration tests:

yarn test:integration

For a quicker loop when developing tests (the builds can take a while) you can use:

# Leave this running in one terminal tab:
yarn test:background

# Repeat this as needed in another terminal tab:
yarn test:quick-integration

Note that the later command will not work unless all the docker services in the public-api profile are up (this is what the first command accomplishes). Furthermore, note that you will need to rerun the first command if you need to make changes to some source location other than __tests__ or __mocks__.

Run all tests

To run all tests you can simply use:

yarn test:all

Extra Resources

• TypeScript in NodeJS Project
• JSON Web Tokens
• Express-jwt
• NodeJS Import Require Conversion
• Defining Process Env Vars for TS
• JWT Argument exception
• Prisma Migrations
• Relational Queries (creation)