Merge branch 'bvander/docs-updates' into 'master'

documentation: updated the docs with new links and getting started

See merge request grassrootseconomics/cic-internal-integration!314

.gitlab/issue_templates/bug.md

@@ -0,0 +1,44 @@
+<!---
+Please read this!
+
+Before opening a new issue, make sure to search for keywords in the issues
+filtered by the "bug" label:
+
+- https://gitlab.com/groups/grassrootseconomics/-/issues?scope=all&state=all&label_name[]=bug
+
+and verify the issue you're about to submit isn't a duplicate.
+--->
+
+### Summary
+
+<!-- Summarize the bug encountered concisely. -->
+
+### Steps to reproduce
+
+<!-- Describe how one can reproduce the issue - this is very important. Please use an ordered list. -->
+
+### Example Project
+
+<!-- If possible, please create an example project here on GitLab.com that exhibits the problematic 
+behavior, and link to it here in the bug report. If you are using an older version of GitLab, this 
+will also determine whether the bug is fixed in a more recent version. -->
+
+### What is the current *bug* behavior?
+
+<!-- Describe what actually happens. -->
+
+### What is the expected *correct* behavior?
+
+<!-- Describe what you should see instead. -->
+
+### Relevant logs and/or screenshots
+
+<!-- Paste any relevant logs - please use code blocks (```) to format console output, logs, and code
+ as it's tough to read otherwise. -->
+
+
+### Possible fixes
+
+<!-- If you can, link to the line of code that might be responsible for the problem. -->
+
+/label ~"bug"

README.md

@@ -1,41 +1,19 @@
-# cic-internal-integration
+# Community Inclusion Currency Stack (CIC Stack) 
+
+A custodial evm wallet for executing transactions via USSD
 
 ## Getting started 
 
 This repo uses docker-compose and docker buildkit. Set the following environment variables to get started:
 
-
 ```
 export COMPOSE_DOCKER_CLI_BUILD=1
 export DOCKER_BUILDKIT=1
 ```
 
-start services, database, redis and local ethereum node
+To get started see [./apps/contract-migration/README.md](./apps/contract-migration/README.md)
-```
-docker-compose up -d
-```
 
-Run app/contract-migration to deploy contracts
+## Documentation 
-```
-RUN_MASK=3 docker-compose up contract-migration
-```
 
-stop cluster
+[https://docs.grassecon.org/cic_stack/](https://docs.grassecon.org/cic_stack/)
-```
-docker-compose down
-```
 
-stop cluster and delete data
-```
-docker-compose down -v --remove-orphans
-```
-
-rebuild an images
-```
-docker-compose up --build <service_name>
-```
-
-to delete the buildkit cache
-```
-docker builder prune --filter type=exec.cachemount
-```

apps/contract-migration/README.md

@@ -27,6 +27,7 @@ In the current version of the scripts, two token types may be deployed; [`giftab
 This step may be run multiple times, as long as the token symbol is different from all previously deployed tokens.
 
 
+
 ## 4. Initialize custodial engine.
 
 Adds system accounts to the custodial engine, and unlocks the initialization seal. After this step, the custodial system is ready to use.
@@ -35,10 +36,12 @@ Adds system accounts to the custodial engine, and unlocks the initialization sea
 ## Services dependency graph
 
 1. evm
-2. bootstrap runlevel 1
+2. bootstrap runlevel 1 - deploy global contracts (RUN_MASK=1 docker-compose up bootstrap)
-3. bootstrap runlevel 2
+3. bootstrap runlevel 2 - deploy instance contracts (RUN_MASK=2 docker-compose up bootstrap)
-4. bootstrap runlevel 3
+4. bootstrap runlevel 4 - deploy token (RUN_MASK=4 docker-compose up bootstrap)
 5. redis
 6. postgres
-7. cic-eth-tasker
+7. cic-eth-tasker 
-8. boostrap runlevel 4
+8. boostrap runlevel 8 - deploy custodial contracts (RUN_MASK=8 docker-compose up bootstrap)
+9. boostrap runlevel 16 - data seeding for development (RUN_MASK=16 docker-compose up bootstrap)
+10. bring up the remainig services (docker-compose up -d)

docker-compose.yml

@@ -67,7 +67,7 @@ services:
       RUN_MASK: ${RUN_MASK:-0}
       TOKEN_NAME: $TOKEN_NAME
       TOKEN_SYMBOL: $TOKEN_SYMBOL
-      TOKEN_TYPE: $TOKEN_TYPE
+      TOKEN_TYPE: ${TOKEN_TYPE:-giftable_erc20_token}
       TOKEN_DECIMALS: $TOKEN_DECIMALS
       TOKEN_REDISTRIBUTION_PERIOD: $TOKEN_REDISTRIBUTION_PERIOD
       TOKEN_SUPPLY_LIMIT: $TOKEN_SUPPLY_LIMIT