tg-notebot

module
v0.0.0-...-ab5ebe4 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 12, 2022 License: MIT

README

ArthurNotesBot

Go Report Card Tests License

So instead of talking a lot let me just show you the demo of this noteBot:

This is a simple bot for storing your notes. For example, if you hear about some interesting film, and you are afraid that you'll forget it's name, you can just open your Telegram and save your film's title using this bot. It's not convenient to use your phone's notes, and it's not convenient to text the title of these films/books in your chat with yourself.

This was my problem and this is my solution to it. Now I can easily store anything I need to memorize in 2 actions: open Telegram on my phone and send a note to this bot.

You can try it yourself if you have a Telegram account https://t.me/ArthurNotesBot (if it's not working then I disabled it, but I hope that I won't)

Under the hood, this project has MongoDB. This database has only one collection - users. User's categories and notes are stored inside of his document. user's document

Commands

Docker-compose

Run the application

make up

Down the application

make down

Tests

Run unit tests

make test

Linters

Run linters (you have to have golangci-lint installed on your PC)

make lint

Integration Tests

Run integration tests

make integration-tests

Directories

Path Synopsis
cmd
app
internal
app
repository/mocks
Package mock_repository is a generated GoMock package.
Package mock_repository is a generated GoMock package.
services/mocks
Package mock_services is a generated GoMock package.
Package mock_services is a generated GoMock package.
telegram/handlers/mocks
Package mock_handlers is a generated GoMock package.
Package mock_handlers is a generated GoMock package.
telegram/mocks
Package mock_telegram is a generated GoMock package.
Package mock_telegram is a generated GoMock package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL