![Logo](/prsm/crystal-nest/raw/main/logo.png)
A Nest rewrite of crystal, the SOS Discord bot
Explore the docs »
Report Bug
·
Request Feature
Table of Contents
A Nest rewrite of crystal, the SOS Discord bot.
This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.
This application uses a multi-stage docker build, to work both locally and on the server. Please don't install the dependencies manually
-
Install docker
-
Copy the
.env.example
to.env
and fill it out correctly. TheAPP_ENV
flag should be set todevelopment
if you run it locally andproduction
when deploying. This ensures the correctly docker build will be done. -
cd into the directory and run
docker compose up --build
Deploy image with a postgres db and see the slash commands.
- Init
- Events
- Roles
- Channels
- Jira integration
See the open issues for a full list of proposed features (and known issues).
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
Distributed under the MIT License. See LICENSE
for more information.
Jonas Schultheiss - @SchultheissJ - jonas.schultheiss@sos-esports.com
Project Link: https://github.com/prsm/crystal-nest
- Product owner Tobias Zischler
- Product owner Callum Stringer
- Previous dev Jasmin