Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sisou/pool-dashboard
Dashboard for Nimiq Mining Pools
https://github.com/sisou/pool-dashboard
Last synced: about 2 months ago
JSON representation
Dashboard for Nimiq Mining Pools
- Host: GitHub
- URL: https://github.com/sisou/pool-dashboard
- Owner: sisou
- Created: 2020-04-28T09:33:33.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-01-16T13:06:04.000Z (almost 2 years ago)
- Last Synced: 2023-03-28T21:09:47.194Z (almost 2 years ago)
- Language: JavaScript
- Homepage:
- Size: 361 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Pool Dashboard
A Nimiq mining pool website with a stats page and dashboard for miners to check their hashrate and pool balance.
Made for Nimiq Mining Pools that use [the official pool implementation](https://github.com/nimiq/mining-pool).
## Configuration
To use this dashboard for your pool, you need to change a couple of files before building:
### `.env`
This file contains relevant settings of your pool, so that the website can connect to your database, generate statistics and generate miner dashboards.
**Database:** If you are running with a non-standard MySQL database, username or hostname, you must adapt the `DB_*` settings in this file to your server configuration.
**Pool Data:** For the website to display your pool name, description and mining-fee, you must adapt the `POOL_*`settings to your pool configuration.
### `static/manifest.json`
For the PWA install prompt and the homescreen icon to show your pool name, you must adapt the `name` and `short_name` fields in this file.
### `favicon.ico` and PWA icons
Replace `static/favicon.ico`, `static/logo-192.png` and `static/logo-512.png` with the logo of your pool. Make sure to keep the pixel sizes of the images.
## Build
After you changed the above files, you need to install the dependencies and build the project:
```bash
yarn install # or `npm install`
yarn build # or `npm run build`
```
## Deployment
Start the webserver directly:
```bash
yarn start # or `npm run start`
```
To run with PM2:
```bash
pm2 start /path/to/pool-dashboard/__sapper__/build --cmd /path/to/pool-dashboard
```
By default, the server is listening on port `3000`. To change this, set the environment variable `PORT` or hard-code the port in `src/server.js`.
## Development
This is a [Sapper](https://sapper.svelte.dev) project, so please read the Sapper docs for details.
This project additionally uses [TailwindCSS](https://tailwindcss.com) for styling, so to start a development environment, you need to run these two commands in two different terminal instances:
```bash
yarn dev # or `npm run dev`
```
```bash
yarn watch:tailwind # or `npm run watch:tailwind`
```