~jae/neos-headless-manager

README: add dev instructions and versions
meta: pin node and yarn version
dMon: add base for server uptime daemon

refs

beep
browse  log 

clone

read-only
https://git.sr.ht/~jae/neos-headless-manager
read/write
git@git.sr.ht:~jae/neos-headless-manager

You can also use your local clone with git send-email.

#Neos Manager

Headless manager for NeosVR that relies on Docker. The software is in no way production ready and is in active development. There is no release date planned.

#Getting started

#Setting up dev environment

You will need:

  • Yarn >= 1.22.19
  • Node >= 16.19.0
  • Docker

Getting started with the dev environment:

git clone https://git.sr.ht/~jae/neos-headless-manager
cd neos-headless-manager
yarn
docker run --name ndb -p 127.0.0.1:5432:5432 -e POSTGRES_DB=neos -e POSTGRES_USER=neos -e POSTGRES_PASSWORD=neos -d postgres:14-alpine

Then create a .env file containing the following:

DB_NAME=neos
DB_USER=neos
DB_PASSWORD=neos
DB_HOST=localhost

Then run:

yarn migrate
yarn dev

#Commands

The current commands available via yarn:

yarn dev # starts the dev environment
yarn build # builds a production ready app
yarn lint # runs eslint
yarn migrate # runs all migrations
yarn migrateup # runs the first migration not done

#Roadmap

  • API + JWT
  • Image management
  • Server management
  • Automatic map rotations
  • Easy configuration edition
  • Headless mod

#Licensing

This software is licensed under the GNU GPLv3.