diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f2bc02de3..052c01c15 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -15,7 +15,7 @@ 2. [Install the Firebase CLI](https://firebase.google.com/docs/cli) 3. Run `firebase login` on your terminal to log in to the same google account as you just used to create the project. 4. Git clone this project. -5. Run `npm install` in the `functions/` directory +5. Run `npm install` 6. Compile `public/css/style.scss` to `public/css/style.min.css` as [described below](https://github.com/Miodec/monkeytype/blob/master/CONTRIBUTING.md#standards--conventions) 7. Rename `.firebaserc_example` to `.firebaserc` and change the project name of default to the firebase project id you just created. @@ -37,7 +37,7 @@ - Click "Generate New Private Key" - Save as `serviceAccountKey.json` in the `functions/` directory -9. Run `firebase serve` to start a local server on port 5000. Use ctrl+c to stop it. +9. Run `npm start` to start a local server on port 5000. Use ctrl+c to stop it. - Run `firebase use default` if you run into any errors for this. ## Standards & Conventions diff --git a/package-lock.json b/package-lock.json new file mode 100644 index 000000000..89d545fa6 --- /dev/null +++ b/package-lock.json @@ -0,0 +1,5 @@ +{ + "name": "monkeytype", + "version": "1.5.3", + "lockfileVersion": 1 +} diff --git a/package.json b/package.json new file mode 100644 index 000000000..b61d5cac4 --- /dev/null +++ b/package.json @@ -0,0 +1,11 @@ +{ + "name": "monkeytype", + "version": "1.5.3", + "scripts": { + "start": "firebase serve", + "postinstall": "cd functions && npm install" + }, + "engines": { + "node": "10" + } +}