Solaris is a slow-burn browser game heavily inspired by Neptune's Pride and Subterfuge.
Visit solaris.games to play now!
The server uses the following tech:
The client uses the following tech:
master
.npm install
in both client/
and server/
directories..env
file in server/
(See .env.example
)..env
file in client/
(See .env.example
).npm run start-jobs:dev
in server/
to start the automated jobs and setup new games.npm run start-api:dev
in server/
to start the API.npm run serve
in client/
to start the client application.Note: Development work is to be based on the dev
branch, for a new feature or bug fix, create a branch from dev
.
To keep up to date with the latest changes, you must run the database migations to ensure that your database is compatible.
npm run start-db-migrate:dev
in server/
to update your local database to the latest schema.Note: This script assumes that you have a solaris
database on your system. If not, perform the Development Environment Setup above first.
To automate the development environment, it is recommended to use PM2.
pm2
.pm2 start pm2.config.js
to register pm2
apps.The above script will create the server jobs, API and client applications, watch for changes and restart those applications when necessary.
You can make use of debugger attach for VS Code defined in the .vscode/launch.json
configuration file to easily attach the debugger to running apps.
Once configured, you can browse to the site locally (default http://localhost:8080) as using the normal way detailed in the section above and any changes you make will automatically restart the applications.
.env
file in server/
(See .env.example
)..env
file in client/
(See .env.example
).docker compose up
in the project folderSee here.
See here.