Skip to content

Commit

Permalink
docs: update readme, manifest and description
Browse files Browse the repository at this point in the history
  • Loading branch information
ottodevs committed Jan 24, 2020
1 parent 35f7ae2 commit 0c1d34b
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 61 deletions.
79 changes: 20 additions & 59 deletions .github/README.md
Original file line number Diff line number Diff line change
@@ -1,91 +1,50 @@
# Aragon About App 🦅🗣

A new about page for Aragon DAO´s
A customizable interface to add interactive widgets with information and insights about your organization.

## Usage

### Launch the custom client with about support
### Launch a new DAO with about app installed along with Voting and Tokens apps

1. Clone Aragon about, run a devchain and publish `about` to this devchain
`npm run start:ipfs:template`

```sh
git clone https://github.com/AutarkLabs/about.git
cd about
npm i # install dependencies
npx aragon ipfs # run ipfs local node
npx aragon devchain # run local ganache-cli devchain
# add "--reset" to delete previous chain data
```

2. Open another terminal and go again into the folder `cd about`

```sh
npm run publish:major -- --environment default
cd ..
```

3. Publish storage app and run the demo template

```sh
git clone [email protected]:AutarkLabs/aragon-storage.git -b demo-template
cd aragon-storage
npm i # install dependencies
npm run start:ipfs:template -- --client false
```

4. Start yet another terminal to run the customized client supporting About setting

```sh
git clone [email protected]:AutarkLabs/aragon.git -b dev
cd aragon
npm i && npm run start:local # download deps and start the client
```
### Development

5. Open the browser at the newly created DAO page
#### Run frontend development server

[http://localhost:3000/#/0xe5ac265B0FFE4b47C8386D7d715f3a3f6F8fb5B9](http://localhost:3000/#/0xe5ac265B0FFE4b47C8386D7d715f3a3f6F8fb5B9)
`npm start`

> It should have About and Storage along with Voting and Token apps installed by default
That should be enough to customize style and frontend changes, as we make use of a stubbed api to simulate some of the aragon client api

### Development
#### Run development template with hot reload and http mode

To start development environment:
`npm run start:http:template``

1. Install dependencies
This launches a DAO but uses the parcel development server ran in the previous step as the app frontend, so hot reload is still working.

```sh
npm i
```
Note this automatically launches `ipfs` and `devchain` daemons, so no need to launch separately, but still possible to do that.

2. Run parcel server for frontend development (it also builds the frontend)
#### For script / store development it is convenient to use the watch script

```sh
npm run dev
```
`npm run watch:script`

3. On a second terminal launch script watcher for background worker development
Works similarly to `npm start` but just keeps recompiling the background worker script related files

```sh
npm run watch:script
```
#### Contract development

4. Yet on another terminal launch the aragon client with the app running and hot reload

```sh
npm run start:http:template
```
It is needed to republish the contract locally between changes, or relaunch the app or template to handle that automatically.

### Publish

You can publish your app on [aragonPM](https://hack.aragon.org/docs/apm). See how in our [publish guide](https://hack.aragon.org/docs/guides-publish).

> **Note**\
> The [Template](https://github.com/aragon/aragon-react-boilerplate/blob/master/contracts/Template.sol) will not be published.
> The [Template](https://github.com/AutarkLabs/about/blob/master/contracts/dev/Template.sol) will not be published.
Example publishing command for Autark deployments:

```sh
npm run publish:patch -- --environment staging --apm.ipfs.rpc https://ipfs.autark.xyz:5001 --ipfs-check false
npm run publish:patch -- --environment rinkeby --apm.ipfs.rpc https://ipfs.autark.xyz:5001 --ipfs-check false
```

### Using a different Ethereum account
Expand All @@ -94,6 +53,8 @@ You can use a different account to interact with you app. [Check the documentati

### Propagate content

Note this is handled automatically by `@aragon/cli` so it should not be needed

You can propagate the content of your app on IPFS. Learn more in our [troubleshooting guide](https://hack.aragon.org/docs/guides-faq#propagating-your-content-hash-through-ipfs) or use the `aragon ipfs propagate` command:

```sh
Expand Down
2 changes: 1 addition & 1 deletion manifest.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "About",
"description": "An about page for Aragon DAO´s",
"description": "A customizable interface to add interactive widgets with information and insights about your organization.",
"author": "Autark",
"changelog_url": "https://github.com/AutarkLabs/about/releases",
"source_url": "https://github.com/AutarkLabs/about/tree/master/",
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@autarklabs/aragon-about",
"version": "0.0.0",
"description": "Aragon About app from Autark",
"description": "A customizable interface to add interactive widgets with information and insights about your organization.",
"main": "app/index.js",
"engines": {
"node": "10.x"
Expand Down
1 change: 1 addition & 0 deletions public/meta/details.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
A customizable interface to add interactive widgets with information and insights about your organization.

0 comments on commit 0c1d34b

Please sign in to comment.