search

counterfactual / monorepo

Home for all packages related to the Counterfactual project
https://counterfactual.com
MIT License
187 stars 44 forks source link

[documentation] better readme on development setup due to various tech stacks and configs #1137

Open alxiong opened 5 years ago

alxiong commented 5 years ago

I feel like the current readme in most sub-package lacks documentation on how to get started as a dev (i.e. environment setup) to contribute due to the overwhelming (IMO) choice of different tech stacks and configurations files one has to set up.

For example I don't particular know what should I put in .env file, and how to test locally. For example, directly running yarn run:playground would give the following error in playground-server:

Error: No mnemonic specified in the NODE_MNEMONIC env var. Please set one.

Yet I'm not too sure how should I set that.

In any case, just point out the friction for the community to contribute and understand the code base.

emansipater commented 5 years ago

Fully agree with this: right now it's very hard to engage with the codebase. Getting clear documentation for each of these code elements (beyond specs.counterfactual.com) is a major priority for us.

emansipater commented 5 years ago

See https://github.com/counterfactual/monorepo/issues/918 as well

snario commented 5 years ago

I think this issue should lead to a solid Getting Started section in the root /README.md file which describes the common ways people will use this Github repo. Then, in that section, link to all of the other README files that will be created in #918 and, specifically for the playground, whatever is done as a result of #1188.