celestial
A Paradise server written in Crystal
Status:
Installation
From Executable
- Download the latest stable release from the releases page.
- Place it in a folder where it won't get lost
From Source
- Install Crystal
git clone https://github.com/paradise-celestial/celestial.git --depth 1
- The `--depth 1` only downloads the latest source; this flag is optional
- In the
celestial
folder, runshards install && shards build --release
- The generated executable will be at
bin/celestial
in thecelestial
folder
Usage
To start the server, run the celestial
executable; the bind address will be logged. Configuration options are coming soon.
Development
- Install using the contributing instructions
- Make changes to the code
- Use
crystal spec
andbin/ameba
to test and lint - Continue with the contributing instructions
Contributing
- Fork it (<https://github.com/paradise-celestial/celestial/fork>)
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
)
- This repository uses Commitizen
<!
- Push to the branch (
git push origin my-new-feature
) - Create a new Pull Request
Contributors
- microlith57 - creator and maintainer
- neauoire - creator of original Paradise implementation; inspiration for project