Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

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

A Nest rewrite of crystal, the SOS Discord bot
https://github.com/prsm/crystal-nest

discord docker docker-compose nestjs prisma

Last synced: 3 days ago
JSON representation

A Nest rewrite of crystal, the SOS Discord bot

Host: GitHub
URL: https://github.com/prsm/crystal-nest
Owner: prsm
License: mit
Created: 2022-06-06T18:24:29.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2024-10-29T18:04:29.000Z (19 days ago)
Last Synced: 2024-10-29T20:10:59.790Z (19 days ago)
Topics: discord, docker, docker-compose, nestjs, prisma
Language: TypeScript
Homepage:
Size: 2.74 MB
Stars: 4
Watchers: 0
Forks: 1
Open Issues: 11
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        


[![Contributors][contributors-shield]][contributors-url]

[![Forks][forks-shield]][forks-url]

[![Stargazers][stars-shield]][stars-url]

[![Issues][issues-shield]][issues-url]

[![MIT License][license-shield]][license-url]






  

    

  

crystal-nest


  


    A Nest rewrite of crystal, the SOS Discord bot

    


    Explore the docs »

    


    


    Report Bug

    ·

    Request Feature

  



  Table of Contents

  


    

      About The Project

      

        Built With

      

    

    

      Getting Started

      

        Prerequisites

        Installation

      

    

    Usage

    Roadmap

    Contributing

    License

    Contact

    Acknowledgments

  


## About The Project

A Nest rewrite of crystal, the SOS Discord bot.

(back to top)


### Built With

- [NestJS](https://nestjs.com/)

- [discord-nestjs](https://github.com/fjodor-rybakov/discord-nestjs)

- [Docker](https://www.docker.com/)

- [Docker Compose](https://docs.docker.com/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

  ```sh

  docker compose up --build

  ```

(back to top)


## Usage

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

(back to top)


## Roadmap

- [x] Init

- [x] Events

- [x] Roles

- [x] Channels

- [ ] Jira integration

See the [open issues](https://github.com/prsm/crystal-nest/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](https://twitter.com/SchultheissJ) - [email protected]

Project Link: [https://github.com/prsm/crystal-nest](https://github.com/prsm/crystal-nest)

(back to top)


## Acknowledgments

- Product owner [Tobias Zischler](https://github.com/zischler)

- Product owner [Callum Stringer](https://github.com/cstringer17)

- Previous dev [Jasmin](https://github.com/GiyoMoon)

(back to top)


[contributors-shield]: https://img.shields.io/github/contributors/prsm/crystal-nest.svg?style=for-the-badge

[contributors-url]: https://github.com/prsm/crystal-nest/graphs/contributors

[forks-shield]: https://img.shields.io/github/forks/prsm/crystal-nest.svg?style=for-the-badge

[forks-url]: https://github.com/prsm/crystal-nest/network/members

[stars-shield]: https://img.shields.io/github/stars/prsm/crystal-nest.svg?style=for-the-badge

[stars-url]: https://github.com/prsm/crystal-nest/stargazers

[issues-shield]: https://img.shields.io/github/issues/prsm/crystal-nest.svg?style=for-the-badge

[issues-url]: https://github.com/prsm/crystal-nest/issues

[license-shield]: https://img.shields.io/github/license/prsm/crystal-nest.svg?style=for-the-badge

[license-url]: https://github.com/prsm/crystal-nest/blob/master/LICENSE