├── .gitmodules ├── LICENSE └── README.md /.gitmodules: -------------------------------------------------------------------------------- 1 | [submodule "mousexplore-frontend"] 2 | path = mousexplore-frontend 3 | url = git@github.com:norestlabs/mousexplore-frontend.git 4 | [submodule "mousexplore-vcoins"] 5 | path = mousexplore-vcoins 6 | url = git@github.com:norestlabs/mousexplore-vcoins.git 7 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2018 No Rest Labs 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # mousexplore 2 | The MouseXplore Block Explorer 3 | 4 | This project is created by MouseBelt and No Rest Labs to serve as a multi-currency block explorer. It supports both testnet and livenet transactions for cryptocurrencies, and is made to be easily branded and forked. 5 | 6 | ### Getting Started 7 | 8 | This is a repository containing the latest release, and both paired submodules. You will need both the frontend and backend module to run this application (we have a [sample hosted deployment](https://mousexplore.mousebelt.com) available online as well). 9 | 10 | To get started, you will need to host the frontend and backend on whichever instances you wish to run the explorer on. You can also download the latest releases recursively from this module using the following commands. 11 | 12 | ##### Using HTTPS: 13 | ``` 14 | git clone --recurse-submodules -j8 https://github.com/norestlabs/mousexplore.git 15 | ``` 16 | 17 | ##### Using SSH: 18 | ``` 19 | git clone --recurse-submodules -j8 git@github.com:norestlabs/mousexplore 20 | ``` 21 | 22 | ### Project Structure 23 | 24 | There are two components: A frontend that serves as a ui, and a backend "vcoins" layer that serves enriched blockchain information through a Rest API. 25 | 26 | [**mousexplore-frontend**](https://github.com/norestlabs/mousexplore-frontend) - This is the frontend, it is a React app. It supports toggling between cryptocurrencies and is mobile responsive. You can alter the config file to select any of the cryptocurrencies you would like to support and their hosting location, or add one of your own. Pull requests are welcome against the repo. 27 | 28 | [**mousexplore-vcoins**](https://github.com/norestlabs/mousexplore-vcoins) - This is the backend, a nodejs cron and rest API that connects to mongodb and the specific node you would like to serve information from. To setup, clone the backend repo, then follow the specific setup instructions in the folder to share data. Pull requests are welcome to add new features, blockchains or any fixes you see that should be made. You are also welcome to copy it and add your own cryptocurrency. We recommend using whichever existing blockchain is closet to your application for this reason. 29 | 30 | ### Documentation 31 | 32 | The [**API Docs**](https://github.com/norestlabs/mousexplore-vcoins/wiki) can be found inside of the vcoins repo. MouseBelt maintains APIs for the cryptocurrencies listed in the repo, you are welcome to host them yourself! 33 | 34 | ### Contributing 35 | 36 | If you see a change you would like to make, please file an issue in the appropriate repository. If you are unsure or have a general request, file it inside this one. 37 | 38 | ### Usage 39 | 40 | You are free to copy this repository and use however you like, under the MIT license. If you do end up using it, send a link! We'd love to see more copies out in the wild. 41 | --------------------------------------------------------------------------------