Skip to content

Update docs #165

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
husa wants to merge 2 commits into
base: develop
Choose a base branch
from
Open

Update docs #165

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7393d03
remove outdated configuration options, update Infura vars
husa May 25, 2020
9175a4b
Add "build client side" step to getting started
husa May 25, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 2 additions & 13 deletions .env.sample
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,19 +33,8 @@ CLOUDINARY_API_SECRET=someValue


# Blockchain
BLOCKCHAIN_HTTP_ADDRESS=https://ropsten.infura.io/0zirIwLN92lsttdtnvNi
BLOCKCHAIN_WS_ADDRESS=wss://ropsten.infura.io/ws
BLOCKCHAIN_HTTP_ADDRESS=https://ropsten.infura.io/v3/your-infura-key
BLOCKCHAIN_WS_ADDRESS=wss://ropsten.infura.io/ws/v3/your-infura-key
BLOCKCHAIN_TOKEN_CONTRACT_ADDRESS=0xaddress
BLOCKCHAIN_TOKEN_SPONSOR_ADDRESS=0xadress
BLOCKCHAIN_TOKEN_SPONSOR_PRIVATE_KEY=key


# CloudWatch Logs
# IMPORTANT: if present, will log to cloudwatch!!!!!
# do not set in development
#
# IAM user with CloudWatchLogsFullAccess permission
CLOUDWATCH_ACCESS_KEY_ID=accessKey
CLOUDWATCH_SECRET_ACCESS_KEY=secretAccessKey
# CloudWatch region
CLOUDWATCH_REGION=eu-west-2
16 changes: 11 additions & 5 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Contributing
We love pull requests from everyone. Any contribution is valuable, but there are two issue streams that we especially love people to work on:

1) Our delivery backlog, is managed via a ZenHub board (ZenHub extensions are available for most major browsers). We use a Kanban-style approach, whereby devs pick issues from the top of the backlog which has been organised according to current priorities. If you have some time and are interested in working on some issues from the backlog, please make yourself known on the [#dev][slack-dev] channel on Slack and we can direct you to the most appropriate issue to pick up.
We love pull requests from everyone. Any contribution is valuable, but there are two issue streams that we especially love people to work on:

2) Our list of bugs and other self-contained issues that we consider to be a good starting point for new contributors, or devs who aren’t able to commit to seeing a whole feature through. These issues are marked with the `# good first issue` label.
1. Our delivery backlog, is managed via a ZenHub board (ZenHub extensions are available for most major browsers). We use a Kanban-style approach, whereby devs pick issues from the top of the backlog which has been organised according to current priorities. If you have some time and are interested in working on some issues from the backlog, please make yourself known on the [#dev][slack-dev] channel on Slack and we can direct you to the most appropriate issue to pick up.

2. Our list of bugs and other self-contained issues that we consider to be a good starting point for new contributors, or devs who aren’t able to commit to seeing a whole feature through. These issues are marked with the `# good first issue` label.

## Getting started

Expand All @@ -21,7 +21,13 @@ We love pull requests from everyone. Any contribution is valuable, but there are
- Check [Configuration Section](#configuration) for configuration instructions
- Check `/.env.sample` file for required variables

4. Start the app
4. Build client-side

```
npm run build:client
```

5. Start the app

4.1 Working on client-side only

Expand All @@ -43,7 +49,7 @@ We love pull requests from everyone. Any contribution is valuable, but there are
npm start
```

5. Client-side development
6. Client-side development

Check [client/README.md](client/README.md) for instructions

Expand Down