Mutual Aid NYC Services List API

A Node.js REST API for interacting with NYC health, human and social services lists stored in Airtable in the Open Referral data format.

Tech Stack

• TypeScript
• Koa
• @koa/router
• koa-bodyparser
• Airtable.js

Requirements

• Node.js
• Yarn 1

Running Locally

• Copy this repo: git clone https://github.com/MutualAidNYC/services-lists-api.git
• Install the Yarn package manager (version 1): npm install --global yarn
• Install dependencies: yarn install
• Copy the sample.env file: cp sample.env .env
• Add your Airtable API key and the id of the Airtable base containing your data to the .env file. You can also change the PORT variable to use a different port - the default is 3001.
• Start a development server: yarn dev. The development script uses nodemon instead of node so that the server automatically restarts with changes.
• The API provides the following routes:
  • GET /services: returns a list of all services
  • GET /taxonomies: returns a list of all taxonomies
  • GET /services-lists: returns a list of all services lists
  • GET /services/:id: returns the service with the given id
  • GET /addresses/:id: returns the addresses with given id
  • GET /services-lists/:id: returns the services list with the given id
  • POST /services-lists: creates new services lists and returns the ids of the created lists

One way to call these routes is with curl.

Linting

ESLint is used to automatically check this project's code for programattic errors (AKA linting).

• To run the linter, run yarn lint - this will check all files in the project except those specified in the .eslintignore file.
• The linter's configuration is specified in the .eslintrc.json file.

Code Formatting

Prettier is used to automatically format this project's code according to Prettier's style guide so it will stay consistently formatted across developers.

• To run the formatter, run yarn format - this will format all the files in the project except those specified in the .prettierignore file.
• The formatter's configuration is specified in the .prettierrc.json file.