Skip to content

pairwise-tech/example-rest-api

Repository files navigation

Pairwise Example HTTP API

An Express server which exposes an example HTTP API for the Pairwise Async Challenges.

The server exposes simple GET, PUT, POST, and DELETE HTTP APIs at the /api path. The server is running at: https://pairwise-example-http-api.appspot.com.

Getting Started

Install NodeJS and yarn and run the following:

# Install dependencies
$ yarn install

# Run the server for development
$ yarn watch

# Run the build
$ yarn build

The project also has some linting rules and tests:

# Apply formatting rules
$ yarn format

# Run project unit tests
$ yarn test:unit

# Run project linting and tests
$ yarn test

Deployment

The app is deployed to Google Cloud App Engine using Google Cloud Build when any commits are pushed to the main branch.