aster-do/aster

Aster

A seamless and customizable metrics collector.

Documentation · Report Bug · Request Feature

📔 Table of Contents

• 📔 Table of Contents
  • 🌟 About the Project
    • 🎯 Features
  • 🏗️ Architecture
  • 🧰 Getting Started
    • ‼️ Prerequisites
    • 🧪 Running Tests
    • 🏃 Run Locally
    • 🚀 Build
  • 👋 Contributing
  • ⚠️ License
  • 🤝 Authors

🌟 About the Project

Aster is designed to efficiently collect metrics from a REST API, transform them into chargeable data, expose the API and SDKs, create invoices and bills, and generate alerts based on specified rules.

🎯 Features

• Collect metrics from a REST API
• Transform metrics into chargeable
• Expose the API and SDKs
• Create invoices and bills
• Alerts based on rules

🧰 Getting Started

‼️ Prerequisites

This project uses Cargo as RUST package manager

curl https://sh.rustup.rs -sSf | sh

🧪 Running Tests

To run tests, run the following command

  cargo test --workspace --bins --lib

🏃 Run Locally

Clone the project

  git clone https://github.com/aster-do/aster.git

Go to the project directory

  cd aster

Build the frontend

  cd frontend && npm run build && cd ..

Run the application

  cargo run

You can now access Aster frontend from http://localhost:3030/.

🚀 Build

Build Aster with Cargo

  cargo build

debug async with tokio console

see tokio-console

./debug-aster.sh

then open the tokio console

tokio-console http://localhost:5555

👋 Contributing

Contributions are always welcome!

See CONTRIBUTING.md for ways to get started.

⚠️ License

Distributed under the TODO License. See LICENSE.md for more information.

🤝 Authors

This project was developed by the Polytech DO teams in June 2023.

Project Link: https://github.com/aster-do/aster