From 1dd629d7470f0fa94f39aad31676dd111cf60175 Mon Sep 17 00:00:00 2001 From: Owocki Date: Tue, 30 Oct 2018 08:55:01 +0100 Subject: [PATCH 1/3] updates the kudos docs for public consumption --- scripts/{fresh_start.bash => mint_test_kudos.bash} | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) rename scripts/{fresh_start.bash => mint_test_kudos.bash} (94%) diff --git a/scripts/fresh_start.bash b/scripts/mint_test_kudos.bash similarity index 94% rename from scripts/fresh_start.bash rename to scripts/mint_test_kudos.bash index ac8a2e8f9c3..9e7507d61b7 100755 --- a/scripts/fresh_start.bash +++ b/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 @@ -27,7 +28,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 From f6a775c95981735af9caab727ecccf949a2d51b6 Mon Sep 17 00:00:00 2001 From: Owocki Date: Tue, 30 Oct 2018 08:57:49 +0100 Subject: [PATCH 2/3] adds kudos docs --- docs/KUDOS.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 docs/KUDOS.md diff --git a/docs/KUDOS.md b/docs/KUDOS.md new file mode 100644 index 00000000000..5dc14101aa2 --- /dev/null +++ b/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 git@github.com: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 + From 743d2e86aa9e57f304230da75b967924d8c8de79 Mon Sep 17 00:00:00 2001 From: Mark Beacom Date: Thu, 1 Nov 2018 09:06:08 -0400 Subject: [PATCH 3/3] Add kudos documentation to doc pipeline --- pydocmd.yml | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/pydocmd.yml b/pydocmd.yml index f4e7d3060c5..c7a85177810 100644 --- a/pydocmd.yml +++ b/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