README
¶
Easyalert
Easyalert is a small application which enables you to send alerts in a simple and straightforward way. It is suitable especially for scripts where you want to notify yourself in case a certain event or failure occurs.
Development
The easiest way to work on easyalert is by using docker.
First run make docker_build to build and pull all the images you need and then run make init to
initialize you local docker environment. Afterwards you can run docker-compose up to start the application.
In case you make library changes or somehow need to rebuild your environment you can just execute
make reset and again make docker_build and make init and you are back up.
It also makes sense to run make docker_clean occasionally which will delete all containers that were exited.
When having the application running using docker-compose up air will automatically
restart the application after every change.
Running tests
You can run tests by executing make test. You should have the database set up as instructed previously.
Applying migrations
Easyalert is using gom for migrations. To apply the latest migrations locally you can run make migrate.
Documentation
¶
Index ¶
Constants ¶
const ( AlertStatusPending = iota AlertStatusSent AlertStatusFailed )
const UserTokenLength = 32
Variables ¶
var ErrRecordDoesNotExist = errors.New("record does not exist")
ErrRecordDoesNotExist is a generic error in case a record which is searched does not exist
Functions ¶
This section is empty.
Types ¶
type Alert ¶
type Alert struct {
ID uint
Subject string
Status uint
SentAt *time.Time
UserID uint
CreatedAt time.Time
UpdatedAt time.Time
}
Source Files
Directories