You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+16-4Lines changed: 16 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -2,12 +2,26 @@
2
2
3
3
Website for viewing up-to-date statistics for codebar.
4
4
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
+
5
17
## Fetching the data
6
18
7
19
This repo contains a [script](./get-data/index.js) for running SQL queries against the codebar Postgres database.
8
20
9
21
The script writes the result of the queries to the [data](./www/data) directory within the front end.
10
22
23
+
To fetch the data, run
24
+
11
25
```sh
12
26
yarn data
13
27
```
@@ -18,6 +32,8 @@ yarn data
18
32
DB_URL=<databse-url>
19
33
```
20
34
35
+
The databse url can be found in Heroku.
36
+
21
37
## Start the frontend
22
38
23
39
```sh
@@ -31,7 +47,3 @@ See more [here](./www)
31
47
Simply pushing to `master` will trigger Github Actions to run checks and then deploy to Github Pages.
32
48
33
49
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