EDCD / coriolis

Coriolis Shipyard for Elite Dangerous
https://coriolis.io
Other
262 stars 83 forks source link

Chat to us on Discord

About

The Coriolis project was inspired by E:D Shipyard and, of course, Elite Dangerous. The ultimate goal of Coriolis is to provide rich features to support in-game play and planning while engaging the E:D community to support its development.

Coriolis was created using assets and imagery from Elite: Dangerous, with the permission of Frontier Developments plc, for non-commercial purposes. It is not endorsed by nor reflects the views or opinions of Frontier Developments and no employee of Frontier Developments was involved in the making of it.

Contributing

Development

This release includes the ability to run the app as a Docker container.

> git clone https://github.com/EDCD/coriolis.git
> git clone https://github.com/EDCD/coriolis-data.git
> cd coriolis
> docker buildx build --build-context data=../coriolis-data --tag coriolis .
> docker run -d -p 3300:3300 coriolis

Or to run an instance of coriolis without Docker Desktop, perform the following steps in a shell:

> git clone https://github.com/EDCD/coriolis.git
> git clone https://github.com/EDCD/coriolis-data.git
> cd ./coriolis-data
> npm install
> cd ../coriolis
> npm install
> npm start

You will then have a development server running on localhost:3300.

Ship and Module Database

See the Data wiki for details on structure, etc.

Deployment

Follow the steps for Development as above, but instead of npm start you'll want to:

> npm run build

this will result in a build/ directory being created containing all the necessary files.

After this you need to serve the files in some manner. Either configure your webserver to make the actual build/ directory visible on the web, or alternatively copy it to somewhere to serve it from.