coriolis - Improve the Elite Dangerous gameplay with Coriolis' advanced planning and simulation tools

Coriolis Project Overview

The Coriolis project is an initiative inspired by platforms like E:D Shipyard and the popular game Elite Dangerous. Its primary aim is to enhance the gameplay experience by offering comprehensive features for in-game planning and support. By engaging with the Elite Dangerous community, Coriolis seeks to continuously improve and develop its offerings.

An interesting aspect of the Coriolis project is its creation story. It utilizes assets and imagery from Elite: Dangerous, under the permission of Frontier Developments plc, solely for non-commercial purposes. It's important to note that while it was developed independently, it neither reflects the official opinions of Frontier Developments nor involved any of its employees in the development process.

Contributing to Coriolis

For those interested in contributing to the Coriolis project, there are several avenues available:

Anyone can submit issues to report bugs or suggest improvements.
Contributors can also submit pull requests targeting the develop branch to contribute code directly.
A vibrant community discussion takes place on Discord, where fans and contributors can collaborate and share ideas.

Developing Coriolis

Coriolis supports running the application as a Docker container, making it accessible and easy to set up. Here's a quick guide to get started:

Clone the required repositories:

> git clone https://github.com/EDCD/coriolis.git
> git clone https://github.com/EDCD/coriolis-data.git

Build and deploy using Docker:

> cd coriolis
> docker buildx build --build-context data=../coriolis-data --tag coriolis .
> docker run -d -p 3300:3300 coriolis

For those preferring not to use Docker, a local setup option is also available:

Clone the repositories and navigate to the data directory:
```
> cd ./coriolis-data
> npm install
```

Set up the main Coriolis application:

> cd ../coriolis
> npm install
> npm start

Since the application will run on your local machine, you can access it via localhost:3300.

Ship and Module Database

Coriolis includes a detailed database of ships and modules, essential for its planning features. More information regarding the data structure can be found in the Coriolis Data Wiki.

Deploying Coriolis

After development, deployment is straightforward. The process involves building the application for production:

Run the build process:
```
> npm run build
```

Upon completion, a directory named build/ will contain all the necessary files. These files must be served through a web server, which can be set by configuring your web server to serve the new build/ directory or moving it to a location from which you can host it.

In conclusion, the Coriolis project represents an ongoing collaboration between gaming enthusiasts and developers, aiming to enrich the Elite Dangerous experience with a robust set of tools and community-based development.