Skip to content
This repository was archived by the owner on Mar 2, 2021. It is now read-only.

Commit 87f4bf3

Browse files
committed
Update development instructions in readme
1 parent 64e5523 commit 87f4bf3

File tree

2 files changed

+15
-4
lines changed

2 files changed

+15
-4
lines changed

.env-example

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
FIREBASE_API_KEY="abc123"
2+
FIREBASE_AUTH_DOMAIN="abc123"
3+
FIREBASE_DATABASE_URL="abc123"

README.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,17 @@ Public API to [Radio4000.com](https://radio4000.com).
44

55
Documentation and examples can be found here [https://github.com/Internet4000/radio4000-api-docs](https://github.com/Internet4000/radio4000-api-docs).
66

7-
# Deployment
7+
## How to develop
88

9-
To deploy to staging, run `yarn deploy` or `npm run deploy`.
10-
To deploy to production, deploy (to staging) and then run `now alias` (only works if you have now.sh permissions).
9+
- `git clone git@github.com:internet4000/radio4000-api.git`
10+
- `cd radio4000-api; cp .env-example .env` (and enter the real keys)
11+
- `yarn`
12+
- `yarn start`
1113

12-
Peace
14+
## How to deploy
15+
16+
To deploy to staging, run `yarn deploy`.
17+
18+
To deploy to production, first `yarn deploy` and then `now alias` (you need access to the Internet4000 team on now.sh)
19+
20+
Peace

0 commit comments

Comments
 (0)