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
+18-10Lines changed: 18 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,19 +4,19 @@
4
4
5
5
To build this project, you must have the following dependencies installed:
6
6
7
-
-node 10.16.3
8
-
-yarn
7
+
-Node v22
8
+
-NPM
9
9
10
10
## Installation
11
11
12
12
```sh
13
-
yarn
13
+
npm install
14
14
```
15
15
16
16
## Developing
17
17
18
18
```sh
19
-
yarn start
19
+
npm run dev
20
20
```
21
21
22
22
### If you wish to use backend server API, you need to have redis running locally on port 6379 (default for redis)
@@ -27,7 +27,7 @@ yarn start
27
27
brew install redis
28
28
```
29
29
30
-
(Other install directions can be found here: https://redis.io/download)
30
+
(Other install directions can be found [here](https://redis.io/download))
31
31
32
32
Make sure it's running
33
33
@@ -38,17 +38,25 @@ brew services start redis
38
38
Once you have redis installed, start this command
39
39
40
40
```sh
41
-
yarn run start:backend
41
+
npm run start:backend
42
42
```
43
43
44
44
It will create a proxy to `browser-sync` server started by gulp at
45
45
`http://localhost:5000`
46
46
47
47
### Connecting to Big Query
48
-
Connecting to Big Query is not required for running the backend (if you run with UPDATE_DATA=false), but is required for things like catching up ledger data in redis.
49
48
50
-
This project is pulling from SDF's `crypto-stellar` public data set, so no special credentials are required. However you will need a Google Cloud Platform project with a service account to be able to access Big Query.
49
+
Connecting to Big Query is not required for running the backend (if you run with
50
+
UPDATE_DATA=false), but is required for things like catching up ledger data in
51
+
redis.
51
52
52
-
Directions for creating a service account [can be found here](https://cloud.google.com/docs/authentication/getting-started).
53
+
This project is pulling from SDF's `crypto-stellar` public data set, so no
54
+
special credentials are required. However you will need a Google Cloud Platform
55
+
project with a service account to be able to access Big Query.
53
56
54
-
Once you've created a service account, add the service account key json file to the `gcloud` folder under the name `service-account.json`. An example json file shows what the file structure should look like.
57
+
Directions for creating a service account
58
+
[can be found here](https://cloud.google.com/docs/authentication/getting-started).
59
+
60
+
Once you've created a service account, add the service account key json file to
61
+
the `gcloud` folder under the name `service-account.json`. An example json file
0 commit comments