https://github.com/elixircl/mate

🧉 Mate for You is a Discordbot to give points similar to HeyTaco written in Elixir
https://github.com/elixircl/mate

ash-framework chile elixir heytaco liveview phoenix slack

Last synced: 3 days ago
JSON representation

🧉 Mate for You is a Discordbot to give points similar to HeyTaco written in Elixir

• Host: GitHub
• URL: https://github.com/elixircl/mate
• Owner: ElixirCL
• License: agpl-3.0
• Created: 2023-05-14T18:59:04.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-06-28T15:30:12.000Z (5 months ago)
• Last Synced: 2024-06-28T16:57:53.056Z (5 months ago)
• Topics: ash-framework, chile, elixir, heytaco, liveview, phoenix, slack
• Language: JavaScript
• Homepage:
• Size: 573 KB
• Stars: 6
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.adoc
  • License: LICENSE

Awesome Lists containing this project

README

        
= 🧉 Mate For You

This project is a slim clone of https://heytaco.com/[HeyTaco] made in *Elixir*.

== Workflow

1. Add _Mate_ to _Discord_.

2. Write and include _:mate:_ emoji (🧉)  in your messages to show praise, appreciation, or to just simply put a smile on someone's face and include them in the message.

Example

[source,text]

----

Hey thanks for your help @huemul :mate:

----

== Features

=== Must

- [x] Users can receive any amount of mates 🧉 per day.

- [x] Users can give up to 5 mates 🧉 per day to any user.

=== Should

- [x] Have commands to show current stats for the user.

=== Possible

- [ ] Filter with hashtags

- [ ] Have API for Leaderboards (https://www.heytaco.chat/api)

- [ ] Leaderboard page with top receiving users (day, week, month, year).

- [ ] Leaderboard page with top giving users (day, week, month, year).

== Tech Stack

- https://discord.com/[Discord] (or compatibles like https://revolt.chat/[Revolt.chat]).

- Elixir 1.14

- Phoenix

- Nostrum

- PostgreSQL

== Example

image:https://github.com/ElixirCL/mate/assets/292738/271c99b9-733f-4ae4-8225-d1b4084c3d7c[Sent]

image:https://github.com/ElixirCL/mate/assets/292738/9bd58c1c-d001-4570-833b-33be3d702282[Stats]

== Commands

- `!top`: Show top 10 users in the week.

- `!stats`: Show current stats for the user

== License

https://www.gnu.org/licenses/agpl-3.0[image:https://img.shields.io/badge/License-AGPL%20v3-blue.svg[License: AGPL v3]]

== Credits

image:https://img.shields.io/badge/Proudly_Coded_in-🇨🇱_Chile-white?style=for-the-badge[Proudly Coded in - 🇨🇱 Chile]