Skip to content

skybird23333/jand-web

Repository files navigation

jand-web

A web interface for the smash hit JanD.

image

Installing

  1. Install NodeJS.
  2. Clone the repository and enter it.
  3. Run npm i to install dependencies.
  4. Run npm run build to build it.

You can now start jand-web in the background using npm run start. It will by default start at localhost:3000, but you can change its port using the PORT environment variable.

Installation Script

git clone https://github.com/skybird23333/jand-web/
cd jand-web
npm i
npm run build

Running and Updating

The recommended way of running jand-web is to start it with JanD.

cd jand-web && jand start jand-web "npm run start"

(In future versions) jand-web will auto detect whether it is being run under JanD and will exclude itself from the processes list.

To update:

git pull #pull changes
npm i #if any, install additional modules
npm run build #re build the thing
jand restart jandweb #restart jand web

A handy NPM script npm run update is also included for updating(doesn't include restarting jand-web)

Roadmap

see #2