~jae/neos-headless-manager

4a39421c9b8524fff971a40774d0c0e3010d2a6b — Jae Lo Presti (DN0) 5 months ago 9c9641d beep
README: add dev instructions and versions
1 files changed, 38 insertions(+), 0 deletions(-)

M README.md
M README.md => README.md +38 -0
@@ 4,6 4,44 @@ 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