|
2 | 2 |
|
3 | 3 | Web app for creating picker wheels linked to Twitch channel point rewards. |
4 | 4 |
|
5 | | -(Work in progress) |
| 5 | +## Contents |
| 6 | + |
| 7 | +- 🚀 [Features](#features) |
| 8 | +- ⭐ [Credits](#credits) |
| 9 | +- ⚖️ [License](#license) |
| 10 | +- 💻 [Development](#development) |
| 11 | + |
| 12 | +## <a name="features">🚀 Features</a> |
| 13 | + |
| 14 | +- Complete Twitch channel point reward integration. |
| 15 | +- Create, edit and delete Twitch channel point rewards. |
| 16 | +- Select or change the reward used for the wheel |
| 17 | +- Rewards redemption entries list. |
| 18 | +- View and manage entries. |
| 19 | +- Per-reward wheel settings and filters. |
| 20 | +- Twitch live chat with emotes support. |
| 21 | +- Winner celebration display, winner chat integration and timer. |
| 22 | +- Wheel spin sound and volume control. |
| 23 | + |
| 24 | +## <a name="credits">⭐ Credits</a> |
| 25 | + |
| 26 | +- [Nuxt](https://nuxt.com/), the [Vue](https://vuejs.org/) framework for bringing the best development experience. |
| 27 | +- Serverless hosted on [Cloudflare Workers](https://workers.cloudflare.com/). |
| 28 | +- [Nuxt UI](https://ui.nuxt.com) and [Tailwind CSS](https://tailwindcss.com/) for styling. |
| 29 | +- [twurple](https://github.com/twurple/twurple), the Twitch API wrapper. |
| 30 | +- [nuxt-auth-utils](https://github.com/Atinux/nuxt-auth-utils) for sessions and OAuth integrations. |
| 31 | +- [streamer-emotes](https://github.com/ahmedrangel/streamer-emotes) for Twitch channel emotes providers. |
| 32 | +- Audio library powered by [Howler.js](https://howlerjs.com/). |
| 33 | +- [Pinia](https://pinia.vuejs.org/) for state management. |
| 34 | + |
| 35 | +## <a name="license">⚖️ License</a> |
| 36 | + |
| 37 | +Made with ❤️ by [Ahmed](https://github.com/ahmedrangel) and [Yizack](https://github.com/yizack). |
| 38 | + |
| 39 | +Open Source app and published under [MIT License](LICENSE) |
| 40 | + |
| 41 | +## <a name="development">💻 Development</a> |
| 42 | + |
| 43 | +<details> |
| 44 | + <summary>Local development</summary> |
| 45 | + |
| 46 | +```sh |
| 47 | +# Install dependencies |
| 48 | +pnpm install |
| 49 | + |
| 50 | +# Build |
| 51 | +pnpm build |
| 52 | + |
| 53 | +# Development server |
| 54 | +pnpm dev |
| 55 | + |
| 56 | +# Run ESLint |
| 57 | +pnpm lint |
| 58 | + |
| 59 | +# Run typecheck |
| 60 | +pnpm test:types |
| 61 | +``` |
| 62 | + |
| 63 | +</details> |
0 commit comments