Skip to content

About

Structured event recording and tracking system.

Topics

Resources

Code of conduct

Stars

1 star

Watchers

0 watching

Forks

Repository files navigation

EventsRecorder - Structured event recording and tracking system

MIT licensed Pipeline stat Test Coverage Man hours Website Docker

EventsRecorder is a structured event recording and tracking system that allows users to define custom event types and log every occurrence with structured data.

Insights plugins

Open My Plugins after creating event types and records. Choose the event types and fields used by each plugin; the results are calculated when the page loads.

Plugin Result
Weekly Review This and last week's record counts, change, and active days.
Time Investment Hours recorded in a duration field this week, last week, and over 30 days.
Personal Best Maximum and latest values of a numeric field, their gap, and days since the best.
Weekly Goal Active days against a target of 1–7 days per week.
Recording Rhythm Typical and latest gaps, variation between gaps, and time since the last record.
Event Association Compares a numeric outcome when a selected event occurred in the preceding 24 hours with other outcomes. The comparison does not show cause and effect.

Weekly counts use UTC weeks starting Monday. The association plugin shows group averages only when each group has at least three outcomes.

screenshot

Default user name is admin@default.com and default password is Admin@123456!.

Try

Try a running EventsRecorder here.

Run in Ubuntu

The following script will install\update this app on your Ubuntu server. Supports Ubuntu 25.04.

On your Ubuntu server, run the following command:

curl -sL https://github.com/aiursoftweb/eventsRecorder/raw/master/install.sh | sudo bash

Of course it is suggested that append a custom port number to the command:

curl -sL https://github.com/aiursoftweb/eventsRecorder/raw/master/install.sh | sudo bash -s 8080

It will install the app as a systemd service, and start it automatically. Binary files will be located at /opt/apps. Service files will be located at /etc/systemd/system.

Run manually

Requirements about how to run

  1. Install .NET 10 SDK and Node.js.
  2. Execute npm install at wwwroot folder to install the dependencies.
  3. Execute dotnet run to run the app.
  4. Use your browser to view http://localhost:5000.

Run in Microsoft Visual Studio

  1. Open the .sln file in the project path.
  2. Press F5 to run the app.

Run in Docker

First, install Docker here.

Then run the following commands in a Linux shell:

image=aiursoft/eventsRecorder
appName=eventsRecorder
sudo docker pull $image
sudo docker run -d --name $appName --restart unless-stopped -p 5000:5000 -v /var/www/$appName:/data $image

That will start a web server at http://localhost:5000 and you can test the app.

The docker image has the following context:

Properties Value
Image aiursoft/eventsRecorder
Ports 5000
Binary path /app
Data path /data
Config path /data/appsettings.json

How to contribute

There are many ways to contribute to the project: logging bugs, submitting pull requests, reporting issues, and creating suggestions.

Even if you with push rights on the repository, you should create a personal fork and create feature branches there when you need them. This keeps the main repository clean and your workflow cruft out of sight.

We're also interested in your feedback on the future of this project. You can submit a suggestion or feature request through the issue tracker. To make this process more effective, we're asking that these include more information to help define them more clearly.

About

Structured event recording and tracking system.

Topics

Resources

Code of conduct

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages