Merge pull request #503 from andogro/ag-README-additions

(enhancement) minor README changes
pull/526/head
Andrew Cravenho 6 years ago committed by GitHub
commit 829f852de1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 33
      README.md
  2. BIN
      explorer_example.gif

@ -23,7 +23,7 @@ Development is ongoing. Please see the [project timeline](https://github.com/poa
- [x] **Smart contract interaction**: Users can read and verify Solidity smart contracts and access pre-existing contracts to fast-track development. Support for Vyper, LLL, and Web Assembly contracts is in progress.
- [x] **ERC20 token support**: Version 1 will support ERC20 token ecosystem. Future releases will support additional token types including ERC223, ERC721, and ERC1155.
- [x] **Token support**: Version 1 supports ERC20 and ERC721 tokens. Future releases will support additional token types including ERC223 and ERC1155.
- [x] **User customization**: Users can easily deploy on a network and customize the Bootstrap interface.
@ -47,30 +47,34 @@ The [development stack page](https://github.com/poanetwork/poa-explorer/wiki/Dev
* For Mac OSX users: `brew install libtool`
* GitHub for code storage
### Setup Instructions
### Build and Run
1. Fork and clone repository.
[`https://github.com/poanetwork/poa-explorer/fork`](https://github.com/poanetwork/poa-explorer/fork)
1. Clone the repository.
`git clone https://github.com/poanetwork/poa-explorer`
2. Set up default configurations.
2. Go to the explorer subdirectory.
`cd poa-explorer`
3. Set up default configurations.
`cp apps/explorer/config/dev.secret.exs.example apps/explorer/config/dev.secret.exs`
`cp apps/explorer_web/config/dev.secret.exs.example apps/explorer_web/config/dev.secret.exs`
Optional: Set up default configuration for testing.
<br />Optional: Set up default configuration for testing.
`cp apps/explorer/config/test.secret.exs.example apps/explorer/config/test.secret.exs`
Example usage: Changing the default Postgres port from localhost:15432 if [Boxen](https://github.com/boxen/boxen) is installed.
3. Install dependencies.
`mix do deps.get, local.rebar, deps.compile, compile`
4. Install dependencies.
`mix do deps.get, local.rebar --force, deps.compile, compile`
4. Create and migrate database.
5. Create and migrate database.
`mix ecto.create && mix ecto.migrate`
<br />_Note:_ If you have run previously, drop the previous database
`mix do ecto.drop, ecto.create, ecto.migrate`
5. Install Node.js dependencies.
6. Install Node.js dependencies.
`cd apps/explorer_web/assets && npm install; cd -`
`cd apps/explorer && npm install; cd -`
6. Start Phoenix Server.
7. Start Phoenix Server.
`mix phx.server`
Now you can visit [`localhost:4000`](http://localhost:4000) from your browser.
@ -83,6 +87,10 @@ _Additional runtime options:_
* Run Phoenix Server with real time indexer
`DEBUG_INDEXER=1 iex -S mix phx.server`
### POA Explorer Visual Interface
![POA Explorer Example](explorer_example.gif)
### Umbrella Project Organization
@ -98,7 +106,6 @@ Each OTP application has a restricted domain.
| `apps/indexer` | `:indexer` | `Indexer` | Uses `:ethereum_jsonrpc` to index chain and batch import data into `:explorer`. Any process, `Task`, or `GenServer` that automatically reads from the chain and writes to `:explorer` should be in `:indexer`. This restricts automatic writes to `:indexer` and read-only mode can be achieved by not running `:indexer`. |
### CircleCI Updates
To monitor build status, configure your local [CCMenu](http://ccmenu.org/) with the following url: [`https://circleci.com/gh/poanetwork/poa-explorer.cc.xml?circle-token=f8823a3d0090407c11f87028c73015a331dbf604`](https://circleci.com/gh/poanetwork/poa-explorer.cc.xml?circle-token=f8823a3d0090407c11f87028c73015a331dbf604)

Binary file not shown.

After

Width:  |  Height:  |  Size: 683 KiB

Loading…
Cancel
Save