Skip to content

Repository files navigation

Medicines 💊

TechnologiesGetting StartedContribute

Medicines is a project aimed at helping users manage their medications efficiently. It provides features to track quantities, schedule dosage times, view registered medicines, and easily add or remove them.

💻 Technologies

  • .NET 8
  • Docker
  • Docker Compose
  • Postgres
  • Background Service
  • telegrambots
  • Entity Framework Core
  • Moq

🚀 Getting started

Commands

- /start [username] - Inicia a interação com o bot e registra o usuário com o nome de usuário especificado.
- /add [remédio] [quantidade] [horário] - Adiciona um remédio com a quantidade especificada e um horário para tomar.
- /remove [remédio] - Remove um remédio da lista.
- /lookup [remédio] - Procura por um remédio específico.
- /list - Exibe a lista de remédios.
- /pills [remédio] [quantidade] - Adiciona uma quantidade de comprimidos a um remédio existente.
- /schedule [remédio] [horário] - Atualiza o horário de um remédio existente.
- /update [remédio] [quantidade] [horário] - Atualiza a quantidade e o horário de um remédio existente.
- /help - Exibe esta mensagem de ajuda.

Obs: the bot talks with the user in portuguese

Examples

  • /start usertest
  • /add dipirona 20 10:00
  • /remove dipirona
  • /lookup dipirona
  • /list
  • /pills dipirona 5
  • /schedule dipirona 13:00
  • /update dipirona 30 16:00
  • /help

Prerequisites

  • .NET 8
  • Docker
  • Telegram Bot Token

Cloning

How to clone your project

git clone https://github.com/ThiagoFBastos/Medicines.git

Config .env variables

Use the .env-example as reference to create your configuration file .env with your Credentials

Starting

How to start your project

docker compose up --build

📫 Contribute

  1. git clone https://github.com/ThiagoFBastos/Medicines.git
  2. git checkout -b feature/NAME
  3. Follow commit patterns
  4. Open a Pull Request explaining the problem solved or feature made, if exists, append screenshot of visual modifications and wait for the review!

Documentations that might help

📝 How to create a Pull Request

💾 Commit pattern

About

A Telegram bot that helps you manage your medicines, including tracking quantities and schedules.

Topics

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages