observabilittle

A small eye in the cloud. 👁️🌨️

An observability platform! Remembers what happened & when.

TODO: Write more description

Installation

TODO: Write installation instructions here

Usage

How to run the server

TODO

How to send logs

TODO

How to retrieve info (API)

TODO

Development

We like people and hope you feel welcome to contribute to observabilittle! We welcome your questions, just open a GitHub issue! TODO make this a link ^^

Background Knowledge

In order to develop observabilittle, knowledge about one or two of these areas is useful:

• Crystal reference api
• Database SQLite
• ORM (We're using Granite)
• Logging - https://12factor.net/logs

Requirements

• Install Crystal 1.3: https://crystal-lang.org/install/
• Run shards install to install dependencies

MVP Design Diagram

This is a work in progress! Our MVP Diagram

How To Build

$ shards build

How To Test

$ crystal spec --error-trace

Contributing

1. Fork it (https://github.com/your-github-user/observabilittle/fork)
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request

Contributors

• YANA - co-creator and maintainer
• Ryan Prior - co-creator and maintainer

🐃 "No yaks were harmed in the making of this repo." -Aneurysm9