@@ -12,32 +12,34 @@ You can check blocks, transactions and their states.
1212
1313[ https://explorer.skycoin.net ] ( https://explorer.skycoin.net )
1414
15- ### Quick reference
15+ # Table of Contents
1616
17- - ** Where to file issues** :
18- [ https://github.com/skycoin/skycoin-explorer/issues ] ( https://github.com/skycoin/skycoin-explorer/issues )
17+ <!-- MarkdownTOC levels="1,2,3,4,5" autolink="true" bracket="round" -->
1918
20- # Table of Contents
19+ - [ Installation] ( #installation )
20+ - [Requirements](#requirements)
21+ - [Go](#go)
22+ - [Angular](#angular)
23+ - [ Docker images] ( #docker-images )
24+ - [ API documentation] ( #api-documentation )
25+ - [ Usage] ( #usage )
26+ - [Run a skycoin node](#run-a-skycoin-node)
27+ - [Build the explorer frontend](#build-the-explorer-frontend)
28+ - [Run the explorer](#run-the-explorer)
29+ - [ Development] ( #development )
30+ - [Compiling the angular frontend](#compiling-the-angular-frontend)
31+ - [Formatting](#formatting)
32+ - [Code Linting](#code-linting)
33+ - [e2e Tests](#e2e-tests)
34+ - [Customization](#customization)
35+ - [ Deployment] ( #deployment )
2136
22- - [ Releases Notes] ( CHANGELOG.md )
23- - [ Installation] ( #installation )
24- - [ Requirements] ( #requirements )
25- - [ Usage] ( #usage )
26- - [ Run a skycoin node] ( #run-a-skycoin-node )
27- - [ Run the explorer] ( #run-the-explorer )
28- - [ Docker images] ( #docker-images )
29- - [ API documentation] ( #api-documentation )
30- - [ Development] ( #development )
31- - [ Compiling the angular frontend] ( #compiling-the-angular-frontend )
32- - [ Formatting] ( #formatting )
33- - [ Code Linting] ( #code-linting )
34- - [ Customization] ( #customization )
35- - [ Deployment] ( #deployment )
37+ <!-- /MarkdownTOC -->
3638
3739
38- # Installation
40+ ## Installation
3941
40- ## Requirements
42+ ### Requirements
4143
4244```
4345go>=1.10
@@ -59,6 +61,20 @@ After cloning the project, you will need to run `npm install` to pull in all jav
5961
6062The angular code is compiled to the ` dist/ ` folder.
6163
64+ ## Docker images
65+
66+ If you want to run Explorer on Docker refer to [ Docker instructions] ( docker/images/README.md )
67+
68+ ## API documentation
69+
70+ HTML documentation:
71+
72+ http://explorer.skycoin.net/api.html
73+
74+ JSON formatted API docs:
75+
76+ http://explorer.skycoin.net/api/docs
77+
6278## Usage
6379
6480### Run a skycoin node
@@ -69,6 +85,14 @@ cd skycoin
6985./run.sh
7086```
7187
88+ ### Build the explorer frontend
89+
90+ ``` sh
91+ make build-ng
92+ ```
93+
94+ Note: if you do not want to install NPM or build the frontend, you can use a docker image to run the explorer.
95+
7296### Run the explorer
7397
7498``` sh
@@ -91,20 +115,6 @@ SKYCOIN_ADDR=http://127.0.0.1:3333 ./explorer
91115make run-api
92116```
93117
94- ## Docker images
95-
96- If you want to run Explorer on Docker refer to [ Docker instructions] ( docker/images/README.md )
97-
98- ## API documentation
99-
100- HTML documentation:
101-
102- http://explorer.skycoin.net/api.html
103-
104- JSON formatted API docs:
105-
106- http://explorer.skycoin.net/api/docs
107-
108118## Development
109119
110120After changing the angular frontend, it should be compiled and committed to the repo.
0 commit comments