Skip to content

Commit 945cdf8

Browse files
committed
Update README
1 parent 4bd8df6 commit 945cdf8

File tree

1 file changed

+16
-4
lines changed

1 file changed

+16
-4
lines changed

README.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,26 @@
22

33
Website for viewing up-to-date statistics for codebar.
44

5+
## Setup up
6+
7+
Make sure node is installed - I recommend using [nvm](https://github.com/nvm-sh/nvm).
8+
9+
This project uses [yarn workspaces](https://classic.yarnpkg.com/en/docs/cli/workspace#search), so you'll need to install the dependency manager [yarn](https://classic.yarnpkg.com).
10+
11+
Install packages needed for this project:
12+
13+
```sh
14+
yarn
15+
```
16+
517
## Fetching the data
618

719
This repo contains a [script](./get-data/index.js) for running SQL queries against the codebar Postgres database.
820

921
The script writes the result of the queries to the [data](./www/data) directory within the front end.
1022

23+
To fetch the data, run
24+
1125
```sh
1226
yarn data
1327
```
@@ -18,6 +32,8 @@ yarn data
1832
DB_URL=<databse-url>
1933
```
2034

35+
The databse url can be found in Heroku.
36+
2137
## Start the frontend
2238

2339
```sh
@@ -31,7 +47,3 @@ See more [here](./www)
3147
Simply pushing to `master` will trigger Github Actions to run checks and then deploy to Github Pages.
3248

3349
Read more [here](./www/README.md).
34-
35-
## TODO
36-
37-
- [ ] Setup Github Actions to run the data fetching script once a day

0 commit comments

Comments
 (0)