Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/EDCD/coriolis
Coriolis Shipyard for Elite Dangerous
https://github.com/EDCD/coriolis
Last synced: about 2 months ago
JSON representation
Coriolis Shipyard for Elite Dangerous
- Host: GitHub
- URL: https://github.com/EDCD/coriolis
- Owner: EDCD
- License: other
- Fork: true (cmmcleod/coriolis)
- Created: 2016-10-07T16:17:02.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2024-07-09T20:59:56.000Z (2 months ago)
- Last Synced: 2024-07-10T01:18:45.129Z (2 months ago)
- Language: JavaScript
- Homepage: https://coriolis.io
- Size: 8.31 MB
- Stars: 262
- Watchers: 23
- Forks: 82
- Open Issues: 58
-
Metadata Files:
- Readme: README.md
- Changelog: ChangeLog.md
- License: LICENSE.md
Awesome Lists containing this project
README
[](https://discord.gg/0uwCh6R62aPRjk9w)
## About
The Coriolis project was inspired by [E:D Shipyard](http://www.edshipyard.com/) and, of course, [Elite Dangerous](http://www.elitedangerous.com). 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
- [Submit issues](https://github.com/EDCD/coriolis/issues)
- [Submit pull requests](https://github.com/EDCD/coriolis/pulls) targetting `develop` branch
- Chat to us on [Discord](https://discord.gg/0uwCh6R62aPRjk9w)!
## Development
This release includes the ability to run the app as a Docker container.
```sh
> 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:
```sh
> 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](https://github.com/EDCD/coriolis-data/wiki) for details on structure, etc.
## Deployment
Follow the steps for [Development](#development) as above, but instead
of `npm start` you'll want to:
```sh
> 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.