Skip to content

Backend server for STARPEACE, including API interface, simple persistence platform, and simulation engine, written in TypeScript and using NodeJS.

License

Notifications You must be signed in to change notification settings

starpeace-project/starpeace-server-multiverse-nodejs

Repository files navigation

starpeace-server-multiverse-nodejs

GitHub release GitHub license GitHub issues GitHub stars Discord

Backend server for STARPEACE, including API interface, simple persistence platform, and simulation engine, written in javascript and using NodeJS.

Official Documentation

Documentation for client gameplay can be found on the STARPEACE documentation website.

Roadmap

Active development and gameplay roadmap can be found in RELEASE.md, historical changelog can be found in RELEASE-archive.md, and a rough plan for anticipated next steps can be found in ROADMAP.md.

Current release notes are also available in client at https://client.starpeace.io/release

Security Vulnerabilities

If you discover a security vulnerability within the STARPEACE website, please send an e-mail to [email protected] or open a GitHub issue. All security vulnerabilities will be promptly addressed.

Contributing

All contributions welcome: development, game design, translations, or play-testing; please let us know if you'd like to get involved! Please join Discord chatroom to learn more.

Build and Development

Local development can be accomplished in a few commands. The following build-time dependencies must be installed:

  • Node.js javascript runtime and npm package manager

Retrieve copy of repository and navigate to root:

$ git clone https://github.com/starpeace-project/starpeace-server-multiverse-nodejs.git
$ cd starpeace-server-multiverse-nodejs

Install starpeace-server-multiverse-nodejs dependencies:

$ npm install

Build repository with npm command defined in package.json:

$ npm run build

Once compiled or binary created, multiverse and planets must be initialized with configuration setup, by invoking:

$ node ./dist/app/setup.js

Once configured, server can be started with:

$ node ./dist/app/server.js

Deployment

SSL

https://github.com/therootcompany/greenlock-express.js

Process Manager

https://github.com/Unitech/pm2

License

starpeace-server-multiverse-nodejs is open-sourced software licensed under the MIT license

About

Backend server for STARPEACE, including API interface, simple persistence platform, and simulation engine, written in TypeScript and using NodeJS.

Resources

License

Stars

Watchers

Forks

Packages

No packages published