MyMetrics
MyMetrics helps you whenever the goal is to gather various daily DATA.
I often find myself focused on the rush, and not finding time to answer some basic questions:
- How often have I eaten salty/meaty/sweety this week?
- How much did I sleep during the past days/week?
- So many questions regarding regular activities that tend to be squeezed out whenever the pace accelerate.
Presentation
MyMetrics provide an API for gathering all the metrics. Made in REST, the API tries to be simple and efficient 😄
What is already done?
Well... nothing yet since the project is only starting. But you can see the current milestone here
What is planned?
For the moment mainly a stable API, with both correct tests and doc. The advancement, as you can guess, depends on a lot of things. You can however see the project progress through the issues and milestones.
How to's (⚠️ WIP)
How to launch the application
Get the app
Downloading a runnable jar would be a marvelous feature; although planned, it is not available at the moment.
The easiest way is to either download or clone the project.
Run the app
- With docker //TODO
- With maven //TODO
How to use it
Since mymetrics goal is to provide an API, you can find a swagger documentation: http://{Project_url}/swagger-ui.html#/
For example for local development : http://localhost:8080/swagger-ui.html#/
How to contribute
// TODO: add a contributing.md
License
The project is open-source LICENSE, it therefore tries to comply with all the terms related to the open-source philosophy.