Skip to content

Commit

Permalink
Small cosmetic changes
Browse files Browse the repository at this point in the history
  • Loading branch information
sohkai committed Jul 18, 2019
1 parent b1b5df0 commit 06c83eb
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 6 deletions.
1 change: 1 addition & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ You can also edit a page directly through your browser by clicking the "EDIT" li
## Styleguide and development processes

For the frontends, we use [prettier](https://prettier.io/) and [eslint](https://eslint.org/) to automatically lint and format the project.

For the contracts, we use [eth-lint](https://github.com/duaraghav8/Ethlint) to automatically lint the project.

We generally avoid adding external dependencies if they can be ported over easily, due to numerous NPM-related security issues in the past (e.g. [`event-stream`](https://blog.npmjs.org/post/180565383195/details-about-the-event-stream-incident)).
Expand Down
16 changes: 10 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ This repository contains the following apps:
- **[Vault](apps/vault)**: Securely owns and manages tokens on behalf of a DAO.
- **[Voting](apps/voting)**: Create votes that execute actions on behalf of token holders.

Each of these apps come with a frontend that is compatible with the [Aragon client](http://github.com/aragon/aragon).
Each of the individual apps come with a frontend that is intended to be installed and used through the [Aragon client](http://github.com/aragon/aragon).

You can read more about how the individual apps work in the [Aragon user guide](https://help.aragon.org/category/15-aragon-apps).
You can read more about how each of the individual apps work in the [Aragon user guide](https://help.aragon.org/category/15-aragon-apps).

## Coming soon apps

Expand All @@ -29,25 +29,29 @@ npm install
This installs global package dependencies and also bootstraps the entire monorepo through [`lerna`](https://github.com/lerna/lerna).

> **Note**: the monorepo is set up in such a way that you **must** install it through a `lerna bootstrap` (done automatically after an `npm install`).
>
> If you're only interested in the contract dependencies, and not the frontends, you can use `INSTALL_FRONTEND=false npm install` instead.
> If you're only interested in bootstrapping one package, you can use `npx lerna bootstrap --scope @aragon/<package> --inclede-filtered-dependencies`
>
> If you're only interested in bootstrapping one package, you can use `npx lerna bootstrap --scope @aragon/<package> --include-filtered-dependencies`
Running tests on all apps can be done by running `npm run test` at the root directory (note that running all of the tests can take a significant amount of time!).

Running tests of an individual app can be done by running `npm run test` inside an individual app's directory, or through the selective `npm run test:<app>` scripts.

By default, tests are run in a in-memory instance of testrpc.

### Frontends
### App frontends

Developing the frontends locally can be a bit tricky.
Developing the frontends locally can be a bit tricky, due to the frontends' reliance on a properly configured Aragon client.

For now, you can follow [@bpierre's gist](https://gist.github.com/bpierre/22572415b90577aa17e5953fa68980eb#developing-the-apps) on starting an app's local frontend server and connecting it to a locally running Aragon client.
For now, you can follow [@bpierre's gist](https://gist.github.com/bpierre/22572415b90577aa17e5953fa68980eb#developing-the-apps) to start an app's local frontend server and connect it to a locally running Aragon client.

In the future, we will improve this flow to make it much easier to get started.

## Contributing

For some introductory information on what an Aragon app is, and how to build one, please read through the [architecture introduction](https://hack.aragon.org/docs/stack) and [Your first Aragon app](https://hack.aragon.org/docs/tutorial). The [aragonAPI documentation](https://hack.aragon.org/docs/api-intro) is also available as a reference.

#### 👋 Get started contributing with a [good first issue](https://github.com/aragon/aragon-apps/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22).

Don't be shy to contribute even the smallest tweak. 🐲 There are still some dragons to be aware of, but we'll be here to help you get started!
Expand Down

0 comments on commit 06c83eb

Please sign in to comment.