diff --git a/README.md b/README.md index a7f1caec3434c337610d86a68e2e038592bf0637..d01f071d014b3c9ec75a8c422c0bb9d0ec0913eb 100644 --- a/README.md +++ b/README.md @@ -3,3 +3,28 @@ * AIR api base: `https://muniair-f106.restdb.io` * SUN api base: `https://munisun-d71a.restdb.io` * TEMP api base: `https://munitest-16ae.restdb.io` + +# Getting started +1) Install [node.js](https://nodejs.org/en/download/) on your machine +2) Optional, but recommended: install yarn by running `npm install --global yarn` +3) Install dependencies +By NPM +``` +npm install +``` +Or by yarn +``` +yarn +``` +4) Update `src/auth_config.json` with your variables +5) Run the application +By npm +``` +npm start +``` +Or by yarn +``` +yarn start +``` + +