React-based GUI for management and monitoring of Nimbus fleets
Go to file
RadoslavDimchev 3e1fe715e3 fix: use MAC constant instead of string 2023-10-23 20:35:01 +03:00
.github/workflows ci: add step for checking formatting 2023-09-26 12:23:26 +03:00
.storybook fix: clean preview 2023-09-05 10:31:17 +03:00
.yarn dev: switch to `yarn` v3 2023-08-03 12:53:39 +03:00
public feat: add new valid icons 2023-10-23 17:39:31 +03:00
src fix: use MAC constant instead of string 2023-10-23 20:35:01 +03:00
.eslintrc.cjs project reinit 2023-08-03 09:20:54 +03:00
.gitignore build: add `vercel` 2023-08-23 11:31:17 +03:00
.nojekyll fix(ci): add `.nojekyll` file in root 2023-08-21 15:07:08 +03:00
.nvmrc build: add a .nvmrc file 2023-08-03 12:51:10 +03:00
.prettierrc feat: add Tamagui integration 2023-08-04 09:43:07 +03:00
.tool-versions dev: switch to `yarn` v3 2023-08-03 12:53:39 +03:00
.yarnrc.yml dev: switch to `yarn` v3 2023-08-03 12:53:39 +03:00
LICENSE Clean project directory 2023-07-13 14:16:49 +03:00
LICENSE-APACHEv2 Basic README and license files 2023-08-01 10:11:08 +03:00
LICENSE-MIT Basic README and license files 2023-08-01 10:11:08 +03:00
README.md docs: add README explaining how to run project 2023-09-26 12:16:58 +03:00
animations.ts fix: add proper tamagui config 2023-08-10 09:56:22 +03:00
index.html add link preload fonts 2023-09-11 23:20:57 +03:00
package.json Merge branch 'main' into rd.create-deposits 2023-10-12 17:37:07 +03:00
tamagui.config.ts cleanup: remove stray commented out line 2023-08-10 10:25:53 +03:00
themes.ts fix: add proper tamagui config 2023-08-10 09:56:22 +03:00
tokens.ts fix: add proper tamagui config 2023-08-10 09:56:22 +03:00
tsconfig.json project reinit 2023-08-03 09:20:54 +03:00
tsconfig.node.json project reinit 2023-08-03 09:20:54 +03:00
vercel.json ci: add `vercel.json` for vercel to rewrite routes 2023-09-07 15:57:28 +03:00
vite.config.ts debug(ci): set base URL in `.storybook/main` 2023-08-21 20:49:21 +03:00
yarn.lock Merge branch 'main' into rd.create-deposits 2023-10-12 17:37:07 +03:00

README.md

nimbus-gui

A GUI for managing your Nimbus nodes.

Deployed pages showing the project

We have a Storybook up at https://nimbus-gui.github.io/nimbus-gui/ which shows the components of the project. We also have a deployed version of the GUI up at https://nimbus-gui.vercel.app/ which shows the GUI as it currently looks in the main branch of the nimbus-gui/nimbus-gui repository.

Development and running the project yourself

Dependencies

Run yarn in the root directory of the project in order to install dependencies.

Running a development server

If you want to run a development server to see what the GUI looks like you can run the following command:

yarn dev

This will start the server on port 5173 and you can open https://localhost:5173 in order to see the page.

Running storybook locally

If you want to run the Storybook locally you can simply run yarn storybook in the root of the project. This is useful if you want to contribute a component and be sure that it renders as you expect it to, without testing it out on any given page.