fekha / solaris

A HTML5 game of strategy, intrigue and galactic conquest.

Solaris

This is a 4X strategy game that aims to loosely clone the game Neptune's Pride.

Visit solaris.games to play now!

Server

The server uses the following tech:

• Node.js
• Express
• MongoDB
  • Mongoose

Client

The client uses the following tech:

• Vue.js
• PixiJS

Development Environment Setup

1. Install the prerequisites.
   • Node.js
   • MongoDB
2. Clone the repository.
3. Checkout master.
4. npm install in both client/ and server/ directories.
5. Create a .env file in server/ (See .env.example).
6. Create a .env file in client/ (See .env.example).
7. npm start in server/
8. npm run serve in client/
9. Browse to the site locally (default http://localhost:8080).

Note: Development work is to be based on the master branch, for a new feature or bug fix, create a branch from master.

Setup Scripts

See the scripts/ directory for scripts that will perform the setup automatically.

Common Fixes

• If you're on Windows and you get an error running npm install in server/ complaining about node-gyp, try the following command:
  • npm install --global --production windows-build-tools
• If you're using the VS Code debugger, especially for the server/, you'll need to set up your launch.json with these additional properties:
  • "envFile": "${workspaceFolder}/server/.env" in the configuration.

Contributing

See here.

License

See here.