braidpool · priyashuu · Apr 11, 2025 · Apr 11, 2025
@@ -0,0 +1,44 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# production
+/build
+
+# misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+dist
+dist-ssr
+*.local
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?
@@ -0,0 +1,66 @@
+# Braidpool Dashboard
+
+A visualization dashboard for the Braidpool decentralized mining pool.
+
+## Quick Start
+
+```bash
+# Install dependencies
+npm install
+
+# Start development server
+npm run dev
+```
+
+The dashboard will open automatically at http://localhost:3000
+
+## Build for Production
+
+```bash
+# Create optimized build
+npm run build
+
+# Preview production build locally
+npm run preview
+```
+
+## Features
+
+- **Braid Visualization**: Interactive graph of the braid structure
+- **Performance Metrics**: Real-time mining pool statistics
+- **Miner Management**: Monitor and manage connected miners
+- **Network Analysis**: View network health and performance
+
+## Dashboard Sections
+
+1. **Main Dashboard**: Overview of key metrics and status
+2. **Braid Visualization**: Interactive graph showing the DAG structure
+3. **Mining Inventory**: Status of connected mining hardware
+4. **Statistics**: Detailed performance metrics and history
+
+## Data Structure
+
+The dashboard visualizes braid data with the following structure:
+
+- **Nodes**: Individual beads/shares in the braid
+- **Links**: Connections between beads (parent-child relationships)
+- **Cohorts**: Groups of beads organized by mining time/relationship
+
+## Development
+
+This dashboard is built with:
+
+- React 19 with TypeScript
+- Vite for fast development and building
+- Material UI for components
+- D3.js for data visualization
+
+## Troubleshooting
+
+- **Blank screen**: Check browser console for errors
+- **Loading issues**: Verify data files are in the correct format
+- **Visualization problems**: Check browser compatibility (latest Chrome/Firefox recommended)
+
+---
+
+For more details on the Braidpool project, visit the [main repository](https://github.com/braidpool/braidpool).
@@ -0,0 +1,41 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <link rel="icon" href="/favicon.ico" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <meta name="theme-color" content="#000000" />
+    <meta name="description" content="Braidpool Dashboard" />
+    <link rel="apple-touch-icon" href="/logo192.png" />
+    <!--
+      manifest.json provides metadata used when your web app is installed on a
+      user's mobile device or desktop. See https://developers.google.com/web/fundamentals/web-app-manifest/
+    -->
+    <link rel="manifest" href="/manifest.json" />
+    <!--
+      Notice the use of %PUBLIC_URL% in the tags above.
+      It will be replaced with the URL of the `public` folder during the build.
+      Only files inside the `public` folder can be referenced from the HTML.
+
+      Unlike "/favicon.ico" or "favicon.ico", "%PUBLIC_URL%/favicon.ico" will
+      work correctly both with client-side routing and a non-root public URL.
+      Learn how to configure a non-root public URL by running `npm run build`.
+    -->
+    <title>Braidpool Dashboard</title>
+  </head>
+  <body>
+    <noscript>You need to enable JavaScript to run this app.</noscript>
+    <div id="root"></div>
+    <script type="module" src="/src/index.tsx"></script>
+    <!--
+      This HTML file is a template.
+      If you open it directly in the browser, you will see an empty page.
+
+      You can add webfonts, meta tags, or analytics to this file.
+      The build step will place the bundled scripts into the <body> tag.
+
+      To begin the development, run `npm start` or `yarn start`.
+      To create a production bundle, use `npm run build` or `yarn build`.
+    -->
+  </body>
+</html>
@@ -0,0 +1,25 @@
+{
+  "short_name": "React App",
+  "name": "Create React App Sample",
+  "icons": [
+    {
+      "src": "favicon.ico",
+      "sizes": "64x64 32x32 24x24 16x16",
+      "type": "image/x-icon"
+    },
+    {
+      "src": "logo192.png",
+      "type": "image/png",
+      "sizes": "192x192"
+    },
+    {
+      "src": "logo512.png",
+      "type": "image/png",
+      "sizes": "512x512"
+    }
+  ],
+  "start_url": ".",
+  "display": "standalone",
+  "theme_color": "#000000",
+  "background_color": "#ffffff"
+}