OZmap Test

API

Description

Back-end for OZmap challenge.

Routes

• v1
  • GET: /api/v1/users
  • GET: /api/v1/users/id
  • POST: /api/v1/users
  • PATCH: /api/v1/users/id
  • DELETE: /api/v1/users/id
  • GET: /api/v1/regions
  • GET: /api/v1/regions/id
  • POST: /api/v1/regions
  • PATCH: /api/v1/regions/id
  • DELETE: /api/v1/regions/id
  • POST: /api/v1/regions/point
  • POST: /api/v1/regions/near-point

Tech Stack

• Node.js
• Express
• MongoDB
• Mongoose
• OpenCage
• Swagger
• Jest

External Services

• OpenCage

Variables Local

Variables local used for running and debugging the application

HOSTNAME=localhost
PORT=3000
ENV=development
MONGO_DBNAME=OZMap
MONGO_URI=<mongo/docker/connection/uri>
OPENCAGE_API_KEY=<opencage/api/key>

Run Application

cd api/
yarn
yarn dev

Run Tests

yarn test

Run Swagger

http://localhost:3000/api/v1/docs/

APP

Description

Front-end for OZmap challenge.

Tech Stack

• React
• React Router

Run Application

cd app/
yarn
yarn dev