jeromecovington / nestjs-biodiversity

GraphQL service for New York State biodiversity data built using NestJS deployable to AWS Lambda

NestJS Biodiversity

Description

NestJS GraphQL service for New York State biodiversity data.

Installation

$ yarn install

Preparing the database

1. Navigate to the open data set at Biodiversity by County - Distribution of Animals, Plants and Natural Communities and download the CSV file to the data/ directory of this project.
2. Populate the SQLite database by running yarn run migrate:data.

Running the app

# development
$ yarn run start

# watch mode
$ yarn run start:dev

# production mode
$ yarn run start:prod

Using the service

One the database has been migrated and the service has been started, visit http://localhost:3000/graphql in the browser to interact with the GraphiQL Playground, or use the endpoint for your front end app.

Example queries

query {
  findAll(county: "Albany", category: "Plant") {
    id
    county
    scientific_name
    year_last_documented
  }
}

query {
  findOne(id: "QWxiYW55OkxpdGhvYmF0ZXMgcGFsdXN0cmlz") {
    id
    category
    common_name
    county
    distribution_status
    federal_listing_status
    global_conservation_rank
    ny_listing_status
    scientific_name
    state_conservation_rank
    taxonomic_group
    taxonomic_subgroup
    year_last_documented
  }
}

Test

# unit tests
$ yarn run test

# e2e tests
$ yarn run test:e2e

# test coverage
$ yarn run test:cov

Deploying on AWS Lambda

This graphql service may be deployed as an AWS Lambda using the following commands. (Assume AWS credentials exist for your use with the necessary capabilities.)

$ npm install -g serverless
$ yarn serverless:deploy

The script will install dependencies using an AWS Linux docker image due to reliance on native modules. When running the script, confirm the download of corepack in order to enable the yarn package manager on the docker image. Make sure to run yarn install again in order to install on your local architecture once development resumes.

You may need to login or create a free account with serverless in order to run the deploy script.