Skip to content
This repository has been archived by the owner on Aug 31, 2020. It is now read-only.
/ shipments Public archive

Public shipment tracker for Distribute Aid shipments

License

Notifications You must be signed in to change notification settings

distributeaid/shipments

Repository files navigation

Shipments

Build and Release Netlify Status semantic-release Renovate Mergify Status Commitizen friendly code style: prettier

Public shipment tracker for Distribute Aid shipments.

Development

ℹ️ These instructions apply to Unix-based development environments; Linux and Mac users should be fine. Windows users could look into setting up their development environment using WSL2.

Install dependencies

npm ci

Configure the environment

Make this environment variable available:

ℹ️ Linux users can use direnv to simplify the process.

export SHIPMENTS_URL=https://docs.google.com/spreadsheets/d/1f5H0sOY4tfkQF_QkQemt1GHTYd_wgsvBgmzE4miI9g4/export?format=tsv

Fetch fallback shipment data

Fetch the fallback set of shipments from the URL (the app will refetch from the URL on boot):

mkdir -p dist/
npx tsc
node scripts/fetchShipments.js > dist/shipments.json

Start the development server

npm start

Architecture decision records (ADRs)

see ./adr.

Acknowledgements