Skip to content

YueMiyuki/ward-next

Repository files navigation

This is a Next.js project bootstrapped with create-next-app.


Ward Dashboard

ward
CodeFactor commit
ko-fi
Original work

This project is a modern build of Ward Dashboard built with NextJS.

Preview

🌙 Dark mode
☀️ Light mode

Getting Started

First, ensure you have dependencies for node-systeminformation installed. For example, lm-sensors and dmidecode are required to get the temperature and memory info. Also ensure you have git installed to clone this repo

On Ubuntu, run these commmands

sudo apt-get update
sudo apt-get install lm-sensors dmidecode git

Next, we need NodeJS v20+ to run this project, on Ubuntu:

# This is from the NodeJS official documentation
# installs nvm (Node Version Manager)
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.0/install.sh | bash

# download and install Node.js (you may need to restart the terminal)
nvm install 20

# verifies the right Node.js version is in the environment
node -v # should print `v20.18.0`

As we use pnpm for our package manager, we need to install it by running

sudo npm install -g pnpm

Now clone the repo and change directory

git clone https://github.com/YueMiyuki/ward-next
cd ward-next

Install Node dependencies

pnpm install

Build the project

pnpm build

Now you're all set! Start the WebUI by

pnpm start -p <PORT>

Example:

pnpm start -p 3000

Feature request and Issues

Please open an issue on GitHub for any feature request and issue


Made with ❤️ by MiyukiYue