https://github.com/zobweyt/giveaways
An app for hosting fair and reliable giveaways at your discord (https://discord.com)
https://github.com/zobweyt/giveaways
Last synced: 2 months ago
JSON representation
An app for hosting fair and reliable giveaways at your discord (https://discord.com)
- Host: GitHub
- URL: https://github.com/zobweyt/giveaways
- Owner: zobweyt
- License: mit
- Created: 2024-06-07T15:50:18.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2024-06-27T16:03:17.000Z (11 months ago)
- Last Synced: 2025-02-02T06:28:55.937Z (4 months ago)
- Language: C#
- Homepage:
- Size: 79.1 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Giveaways
An app for hosting fair and reliable giveaways at your server.
## 🗝️ Features
* Host unlimited giveaways at your discord servers.
* Manually end giveaways via a [message command](https://discord.com/developers/docs/tutorials/upgrading-to-application-commands#message-commands).
## 🗺️ Roadmap
To see the current and future tasks for this project, please navigate to the [projects](https://github.com/zobweyt/Giveaways/projects) tab.
## 📦 Personal usage
To start, open a command prompt and follow these instructions:
### Step 1 — Get the app
Clone this repository to your machine, open it in your editor, and navigate to the startup project:
```sh
git clone https://github.com/zobweyt/Giveaways.git
cd ./src/Giveaways
```
### Step 2 — Configure the environment
We are using the [options pattern](https://learn.microsoft.com/aspnet/core/fundamentals/configuration/options) for typed access to groups of [related settings](./src/Giveaways/Common/Options). You should configure the [`appsettings.json`](./src/Giveaways/appsettings.json) file or manage [user secrets](https://learn.microsoft.com/aspnet/core/security/app-secrets) via [CLI](https://learn.microsoft.com/dotnet/core/tools):
```sh
dotnet user-secrets set
```
> [!NOTE]
> Pending database migrations are applied automatically [before startup](./src/Giveaways/Program.cs#L49) and an informational [message](./src/Giveaways/Extensions/HostExtensions.cs#L29) is logged.
### Step 3 — Run the app
To run the bot, just execute the following command:
```sh
dotnet watch
```
The setup is done. Enjoy using the app! 🎉
> [!WARNING]
> Instead of using the `dotnet run` in production, create a deployment using the `dotnet publish` command and [deploy](https://docs.discordnet.dev/guides/deployment/deployment) the output.
## 🚀 Contributing
To contribute to this project, please read the [`CONTRIBUTING.md`](.github/CONTRIBUTING.md) file. It provides details on our code of conduct and the process for submitting pull requests.
## ❤️ Acknowledgments
See the [contributors](https://github.com/zobweyt/Giveaways/contributors) who participated in this project and the [dependencies](https://github.com/zobweyt/Giveaways/network/dependencies) used.
## 📜 License
This project is licensed under the **MIT License** — see the [`LICENSE.md`](LICENSE.md) file for details.