/DrugSafeBot

A Discord bot for logging dosages

Primary LanguageJavaOtherNOASSERTION

Contributors Forks Stargazers Issues MIT License


Logo

DrugSafe Discord Bot

A harm reduction discord bot!
Explore this project »

Visit Wiki · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Contributing
  4. License
  5. Contact
  6. Acknowledgments

About The Project

The DrugSafe Discord bot is a custom bot that allows members of any Discord server to log substance doses taken, as well as providing quick access to harm reduction info on dosing, interactions, tripsitting, hotlines, and more!

(back to top)

Built With

Below is a comprehensive list of the frameworks and libraries used to build the DrugSafe Discord bot.

(back to top)

Self Hosting

To get a local copy of the bot up and running, follow these simple steps.

Prerequisites

You must have Java JDK 17 installed on your machine.

Installation

Below are the necessary steps needed to run this project.

  1. Clone the repo: 
    git clone https://github.com/TechnoVisionDev/DrugSafeBot.git
  2. Create a .env file in the root project folder and populate it with all the variables in .env.example.
  3. You can now build and run the application using maven.

(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. You can also contribute monetarily at https://www.patreon.com/drugsafely.

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

DrugSafeBot is licensed under the terms of Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International ("CC-BY-NC-SA-4.0"). Commercial use is not allowed under this license. This includes any kind of revenue made with or based upon the software, even donations.

The CC-BY-NC-SA-4.0 allows you to:

  • Share -- copy and redistribute the material in any medium or format
  • Adapt -- remix, transform, and build upon the material

Under the following terms:

  • Attribution — You must give appropriate credit, provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use.
  • NonCommercial — You may not use the material for commercial purposes.
  • ShareAlike — If you remix, transform, or build upon the material, you must distribute your contributions under the same license as the original.

More information can be found here.

(back to top)

Contact

Thomas Peters - @tomm__peters - tapeters@usc.edu

Project Link: https://github.com/TechnoVisionDev/DrugSafeBot

(back to top)

Acknowledgments

Below are some resources that have been instrumental in making this project a reality!

(back to top)