🌱 The Car(bon) da(shboard) and live mon(itor)
Built with ❤️ by the Root & Branch team
Uh, it's cardmom ACKSUALLY! - we know, but cardamon is a better acronym.Cardamon is a tool to help development teams measure the power consumption and carbon emissions of their software.
DATABASE_URL (do not include database name for postgresql or mysql) DATABASE_NAME (only required for postgresql and mysql)
The easiest way to install Cardamon is using our install script.
Linux & Mac
curl -fsSL https://cardamon.rootandbranch.io/install.sh | sh
Windows
Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
irm -Uri https://cardamon.rootandbranch.io/install.ps1 | iex
Alternatively you can build Cardamon from source if you have cargo
installed.
cargo install cardamon
Coming soon!
Coming soon!
Coming soon!
Coming soon!
Cardamon is released under the PolyForm Shield License 1.0. This allows anyone to use Cardamon, in anyway they wish, as long as it is not used in a product or service which competes with Root & Branch Ltd (the company behind Cardamon).
Root & Branch Ltd sell software consultancy services and use Cardamon internally to provide those services to their clients, so as long as you don't use Cardamon to provide a product or service similar to those offered by Root & Branch then you are free to use it any project, commercial or otherwise.
We're a friendly bunch! Feel free to create an issue in github (make sure to give the
help
label) and we will help in anyway we can. Alternatively email us at hello@rootandbranch.io
There are many ways you can contribute to the project.
- Help us improve the documentation.
- Translate the docs into other languages.
- Create example projects to show others how to use Cardamon in their projects.
- Checkout the issues board on github, there's always features and fixes that need implementing.
- Spread the word! Tell others about the project and encourage them to use it.
Cardamon is distributed under the terms of the PolyForm Shield License (Version 1.0).
See LICENSE for details.
Copyright © 2023 Root & Branch ltd