Merge pull request #2566 from gitcoinco/kevin/kudos-docs

updates / adds kudos docs for public consumption

docs/KUDOS.md

@@ -0,0 +1,22 @@
+
+## You guys just launched [Kudos](https://gitcoin.co/kudos).  How do I get/test kudos on my local RPC node?
+
+This answer assumes you're using docker. 
+
+Run these commands
+
+```
+# start from the directory on your local filesystem that contains the gitcoinco web repo
+cd ..
+git clone [email protected]:gitcoinco/Kudos721Contract.git
+cd Kudos721Contract
+npm install openzeppelin
+cd ../web
+bash scripts/mint_test_kudos.bash
+
+```
+
+The above commands clone the Kudos smart contract, installs the dependancies, deploys the smart contract to ganache, and mints several kudos in the newly minted smart contract.
+
+After the `scripts/mint_test_kudos.bash` script runs, you will have kudos on your local docker container, via the localhost RPC node
+

pydocmd.yml

@@ -130,6 +130,20 @@ generate:
     - gitcoinbot.views++
   - healthcheck/healthchecks.md:
     - healthcheck.healthchecks++
+  - kudos/admin.md:
+    - kudos.admin++
+  - kudos/forms.md:
+    - kudos.forms++
+  - kudos/helpers.md:
+    - kudos.helpers++
+  - kudos/router.md:
+    - kudos.router++
+  - kudos/models.md:
+    - kudos.models++
+  - kudos/utils.md:
+    - kudos.utils++
+  - kudos/views.md:
+    - kudos.views++
   - linkshortener/commands.md:
     - linkshortener.management.commands.create_shortlinks++
   - linkshortener/admin.md:
@@ -286,6 +300,15 @@ pages:
       - Admin: gitcoinbot/admin.md
       - Models: gitcoinbot/models.md
       - Views: gitcoinbot/views.md
+    - Kudos:
+      - Local Deployment: kudos_deploy >> docs/KUDOS.md
+      - Admin: kudos/admin.md
+      - Forms: kudos/forms.md
+      - Helpers: kudos/helpers.md
+      - Models: kudos/models.md
+      - Routers: kudos/router.md
+      - Utilities: kudos/utils.md
+      - Views: kudos/views.md
     - Link Shortener:
       - Commands: linkshortener/commands.md
       - Admin: linkshortener/admin.md

scripts/fresh_start.bash → scripts/mint_test_kudos.bash

@@ -7,6 +7,7 @@ read input
 echo "have you installed openzeppelin>? (y/n)"
 read input
 
+KUDOS_CONTRACT_DIR=Kudos721Contract
 
 # If no network is specified, use localhost
 if [ -z $1 ]; then
@@ -26,7 +27,7 @@ sleep 10
 docker-compose exec ipfs sh -c 'ipfs config --json API.HTTPHeaders.Access-Control-Allow-Origin '\''["*"]'\'''
 docker-compose exec ipfs sh -c 'ipfs config --json API.HTTPHeaders.Access-Control-Allow-Methods '\''["PUT", "GET", "POST"]'\'''
 docker-compose restart ipfs
-cd ../gitcoin-erc721 || exit 1
+cd ../$KUDOS_CONTRACT_DIR || exit 1
 truffle migrate --reset
 cd - || exit 1