The Reminder-GO application is a handy task management tool. Using the application, you can easily add, view, delete and change the status of reminds, customize and change them, manage the sending of email notifications by profile and for each remind separately. Application use PostgreSQL to store all reminds
The application can be useful for anyone who needs a convenient task management tool, including entrepreneurs, students, housewives, etc.
- Adding and removing reminds
- Remind status change: when the status changes to "done", the "when completed" date is automatically updated
- View all reminds
- View completed tasks: the ability to view a list of completed reminds in a certain date range with the ability to sort by the date when they should be completed
- View current tasks: give a complete list of current tasks with the ability to sort by the date when they should be completed
- Ability to edit remind - change its title, description, deadline and notification time
- Ability to add your profile notification config. By agreeing to receive notifications by email, you can set how many days before the remind deadline you will receive a letter-notification in your mail. This works across your profile and across all your reminds
- Ability to configure notifications for each remind at your discretion. You can set the notification time for the number of minutes/hours/days you want before the reminder deadline. It works on a similar principle as in Google Calendar
Pre-requisites: GIT, Docker, Docker Compose, Golang v1.19 and newer, MinGW or Cygwin(for Windows users)
Steps:
- Install Docker and Docker Compose manually
- Install Golang v1.19 and newer
- Install git and clone the Reminder-GO repository
- If you are using Windows install MinGW or Cygwin. You need to add the path to the "make" utility to the PATH environment variable to ability to run the "make" utility from the command line.
- Install all dependencies using command
go mod download
Note: Before running the application locally you need an
.envfile which you can get from the admins of Reminder-GO repository. You need add this file in the root folder. Also you need serviceAccountKey.json with credentials for firebase authentication.
All commands and their descriptions are described in Makefile
You can launch all aplication using one single command docker-compose up
Or run next commands step-by-step
make createdb
make migrateup
make db-run
It was launched DB reminder on port :5432 with two tables todo and users_config
make run
make run-worker
Now Application is running on port :8000 and ready to accept requests
- To launch application tests you need run commands:
make mocks
make create_testdb
make migrateup_test
make test
make int_test
- To get test coverage of the application you need run command -
make coverageor in HTML -make coverage-html
To generate actual swagger documentation run make swag_gen
It's Restful API CRUD application with routes"
-
/remind- [method GET] - get list of reminds by query("all", "current", "completed"). Also required params for pagination and date range -
/remind- [method POST] - create new remind -
/remind/${id}- [method GET] - get remind by ID -
/remind/${id}- [method DELETE] - delete remind by ID -
/remind/${id}- [method PUT] - update remind by ID -
/status/${id}- [method PUT] - change remind status -
/configs/${id}- [method GET] - get user notification configs -
/configs/${id}- [method PUT] - update user notification configs
Remidner use Firebase for authentication
You need to pass the verification token in each request. This token is checked in the AuthMiddleware which verifies it via Firebase Auth Client which is initialized with credentials from serviceAccountKey.json in the root folder
This is a service that starts and runs in a goroutine. Every 5 seconds, the service goes through the database and looks for a reminder to send a notification via the SMTP protocol