Skip to content

Latest commit

 

History

History
79 lines (51 loc) · 1.47 KB

readme.md

File metadata and controls

79 lines (51 loc) · 1.47 KB

Begin build status

A web app to help people find Snowy Owls across Canada.

Screenshot of app's map showing sighting data

Setup

npm install

You also need to install dependencies for the HTTP functions:

cd src/http/get-recent
npm install

cd src/http/post-analytics
npm install

eBird Token

You need to request an eBird API Token. Set the value of your token in a new file, .arc-env:

@testing
API_KEY your-token-here

Development

To start a local development server:

npm run dev

Navigate to http://localhost:3000. Use ctrl+c twice to kill the two servers.

Testing

To run linting and tests:

npm run lint
npm test

Building

To build a production bundle in out/:

npm run build

Deploying

To deploy to staging, push to the main branch. Staging is always running what's on main.

To deploy to production, create a tag:

git tag -a 1.x.y -m "v1.x.y"
git push origin 1.x.y

Notes

  • if new HTTP functions are added to src/http/*, remember to also add rewrite rules to the custom dev server for local development: dev.js
  • make sure the entire dev environment stays under ~500M. Use npm run size to check it.