crystal-nest

A Nest rewrite of crystal, the SOS Discord bot
Explore the docs »

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

A Nest rewrite of crystal, the SOS Discord bot.

(back to top)

Built With

• NestJS
• discord-nestjs
• Docker
• Docker Compose

(back to top)

Getting Started

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.

Prerequisites

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. The APP_ENV flag should be set to development if you run it locally and production when deploying. This ensures the correctly docker build will be done.

• cd into the directory and run

  docker compose up --build

(back to top)

Usage

Deploy image with a postgres db and see the slash commands.

(back to top)

Roadmap

• Init
• Events
• Roles
• Channels
• Jira integration

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

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!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

Jonas Schultheiss - @SchultheissJ - [email protected]

Project Link: https://github.com/prsm/crystal-nest

(back to top)

Acknowledgments

• Product owner Tobias Zischler
• Product owner Callum Stringer
• Previous dev Jasmin

(back to top)