1112 documentation update (passportxyz#1315)

* chore(docs): add instructions for scorer api * chore(docs): add instructions for scorer api * chore(docs): point to scorer api * Update README.md --------- Co-authored-by: michaelgreen06 <[email protected]>
spy625 · Jun 2, 2023 · 64e4ef9 · 64e4ef9
1 parent b704382
commit 64e4ef9
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -63,6 +63,14 @@ cp ./schemas/.env-example.env ./schemas/.env
 yarn start
 ```
 
+4. Run the [Passport Scorer API](https://github.com/gitcoinco/passport-scorer/tree/main/api) locally. Set up instructions are [here](https://github.com/gitcoinco/passport-scorer/blob/main/SETUP.md) 
+
+## Passport Data
+
+A passport has two sources of data. The primary source is a postgres database that is hosted by gitcoin. To run the passport application locally you will need spin up the [Scorer API](https://github.com/gitcoinco/passport-scorer/tree/main/api). All relevant instructions to run the scorer api can be found [here](https://github.com/gitcoinco/passport-scorer/blob/main/SETUP.md). The sample environment variables in the .env-example.env files are configured to make requests to the scorer api running locally. Once the scorer api is running locally, you should have a reliable data source for development.
+
+The second source of data is the ceramic network. No steps are needed to run the ceramic network locally. The sample environment variables in the .env-example.env files are configured to make requests to a test version of the ceramic network.
+
 ## Background Knowledge
 
 - Know what a wallet is, how to create one, etc.