119 lines
3.9 KiB
Markdown
119 lines
3.9 KiB
Markdown
# Flosight UI
|
|
|
|
A Florincoin blockchain explorer web application service for [Flocore Node](https://github.com/bitpay/flocore-node) using the [Flosight API](https://github.com/bitpay/flosight-api).
|
|
|
|
## Quick Start
|
|
|
|
Please see the guide at [https://flocore.io/guides/full-node](https://flocore.io/guides/full-node) for information about getting a block explorer running. This is only the front-end component of the block explorer, and is packaged together with all of the necessary components in [Flocore](https://github.com/bitpay/flocore).
|
|
|
|
## Getting Started
|
|
|
|
To manually install all of the necessary components, you can run these commands:
|
|
|
|
```bash
|
|
npm install -g flocore-node
|
|
flocore-node create mynode
|
|
cd mynode
|
|
flocore-node install flosight-api
|
|
flocore-node install flosight-ui
|
|
flocore-node start
|
|
```
|
|
|
|
Open a web browser to `http://localhost:3001/flosight/`
|
|
|
|
## Development
|
|
|
|
To build Flosight UI locally:
|
|
|
|
```
|
|
$ npm run build
|
|
```
|
|
|
|
A watch task is also available:
|
|
|
|
```
|
|
$ npm run watch
|
|
```
|
|
|
|
## Changing routePrefix and apiPrefix
|
|
|
|
By default, the `flosightConfig` in `package.json` is:
|
|
|
|
```json
|
|
"flosightConfig": {
|
|
"apiPrefix": "flosight-api",
|
|
"routePrefix": "flosight"
|
|
}
|
|
```
|
|
|
|
To change these routes, first make your changes to `package.json`, for example:
|
|
|
|
```json
|
|
"flosightConfig": {
|
|
"apiPrefix": "api",
|
|
"routePrefix": ""
|
|
}
|
|
```
|
|
|
|
Then rebuild the `flosight-ui` service:
|
|
|
|
```
|
|
$ npm run build
|
|
```
|
|
|
|
## Multilanguage support
|
|
|
|
Flosight UI uses [angular-gettext](http://angular-gettext.rocketeer.be) for multilanguage support.
|
|
|
|
To enable a text to be translated, add the ***translate*** directive to html tags. See more details [here](http://angular-gettext.rocketeer.be/dev-guide/annotate/). Then, run:
|
|
|
|
```
|
|
grunt compile
|
|
```
|
|
|
|
This action will create a template.pot file in ***po/*** folder. You can open it with some PO editor ([Poedit](http://poedit.net)). Read this [guide](http://angular-gettext.rocketeer.be/dev-guide/translate/) to learn how to edit/update/import PO files from a generated POT file. PO file will be generated inside po/ folder.
|
|
|
|
If you make new changes, simply run **grunt compile** again to generate a new .pot template and the angular javascript ***js/translations.js***. Then (if use Poedit), open .po file and choose ***update from POT File*** from **Catalog** menu.
|
|
|
|
Finally changes your default language from ***public/src/js/config***
|
|
|
|
```
|
|
gettextCatalog.currentLanguage = 'es';
|
|
```
|
|
|
|
This line will take a look at any *.po files inside ***po/*** folder, e.g.
|
|
**po/es.po**, **po/nl.po**. After any change do not forget to run ***grunt
|
|
compile***.
|
|
|
|
|
|
## Note
|
|
|
|
For more details about the [Flosight API](https://github.com/bitpay/flosight-api) configuration and end-points, go to [Flosight API GitHub repository](https://github.com/bitpay/flosight-api).
|
|
|
|
## Contribute
|
|
|
|
Contributions and suggestions are welcomed at the [Flosight UI GitHub repository](https://github.com/bitpay/flosight-ui).
|
|
|
|
|
|
## License
|
|
(The MIT License)
|
|
|
|
Permission is hereby granted, free of charge, to any person obtaining
|
|
a copy of this software and associated documentation files (the
|
|
'Software'), to deal in the Software without restriction, including
|
|
without limitation the rights to use, copy, modify, merge, publish,
|
|
distribute, sublicense, and/or sell copies of the Software, and to
|
|
permit persons to whom the Software is furnished to do so, subject to
|
|
the following conditions:
|
|
|
|
The above copyright notice and this permission notice shall be
|
|
included in all copies or substantial portions of the Software.
|
|
|
|
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
|
|
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
|
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
|
|
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
|
|
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
|
|
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
|
|
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|