Commit 210f3459 authored by Cédric F.'s avatar Cédric F.

Describe project in README

parent b566e606
Copyright (C) 2017 Cédric Félizard
AGPLv3+ license
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
......@@ -26,4 +26,4 @@ dcrd:
bitcoind:
bitcoind -par=-1 -server -txindex -rpcuser=bitcoin -rpcpassword=secret
.PHONY: clean nginx cache_buster dcrd
.PHONY: watch clean nginx cache_buster dcrd
# Trappisto
## WTF is that name?
[![Build Status](https://gitlab.com/infertux/trappisto/badges/master/build.svg)](https://gitlab.com/infertux/trappisto/commits/master)
[TRAPPIST-1](http://www.trappist.one/#about) is a planetary system located 12 parsecs away from the Solar system.
But before we get to explore another planetary system, we can explore our very own blockchain in the Solar system and since the number zero is preceding one:
`TRAPPIST-1 -> TRAPPIST-0 -> TRAPPIST0 -> Trappist0 -> Trappisto`. Yeah I know.
Trappisto is a block explorer designed primarily to explore the
[Decred](https://www.decred.org) blockchain. It aims to:
- have a simple interface
- be mobile-friendly
- always display the latest data
(the page is refreshed automatically thanks to
web sockets)
- be fully usable with keyboard shortcuts only (no mouse required)
(_work in progress_)
- not drown the user with too much technical information
(a handy link to [dcrdata.org](https://explorer.dcrdata.org)
is available if you need more details)
## Support for other coins than DCR
Trappisto has experimental support for BTC and BCH. Both coins provide a
similar JSON RPC API with the exception of the `searchrawtransactions` command.
This means it is not possible to browse addresses as we have no way to retrieve
transactions for a particular address. However it is possible to explore blocks
and transactions.
To configure Trappisto for a different coin, you will need to:
- update `const coin = 'DCR'` in _index.html_
- update `proxy_pass https://localhost:9109/;` in _nginx.conf_
## What does Trappisto mean?
[TRAPPIST-1](http://www.trappist.one/#about) is a planetary system located 12
parsecs away from the Solar system. But before we get to explore another
planetary system, we can explore our very own blockchain in the Solar system
and since the number zero is preceding one:
`TRAPPIST-1 -> TRAPPIST-0 -> TRAPPIST0 -> Trappist0 -> Trappisto`.
Yeah I know.
## Development
......@@ -27,3 +59,15 @@ Test:
```
make test
```
Run:
```
make dcrd
make nginx
make cache_buster
```
## License
AGPLv3+
{
"version": "1.0.0",
"summary": "helpful summary of your project, less than 80 characters",
"repository": "https://github.com/user/project.git",
"license": "BSD3",
"summary": "Trappisto - Interactive Block Explorer",
"repository": "https://github.com/infertux/trappisto.git",
"license": "AGPLv3+",
"source-directories": [
"src"
],
......
{
"version": "1.0.0",
"summary": "Test Suites",
"repository": "https://github.com/user/project.git",
"license": "BSD3",
"summary": "Trappisto - Test Suite",
"repository": "https://github.com/infertux/trappisto.git",
"license": "AGPLv3+",
"source-directories": [
"../src",
"."
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment