Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/homemade-cookies/aspiring

A Template used to create a repository with Aspire
https://github.com/homemade-cookies/aspiring

aspire distributed-systems grafana prometheus test-automation

Last synced: about 2 months ago
JSON representation

A Template used to create a repository with Aspire

Host: GitHub
URL: https://github.com/homemade-cookies/aspiring
Owner: Homemade-Cookies
License: mit
Created: 2024-10-31T14:37:03.000Z (2 months ago)
Default Branch: main
Last Pushed: 2024-11-20T18:43:32.000Z (about 2 months ago)
Last Synced: 2024-11-20T19:26:21.756Z (about 2 months ago)
Topics: aspire, distributed-systems, grafana, prometheus, test-automation
Language: C#
Homepage:
Size: 188 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

README

# Aspiring
[![CI/CD Pipeline](https://github.com/Homemade-Cookies/Aspiring/actions/workflows/ci-cd.yml/badge.svg)](https://github.com/Homemade-Cookies/Aspiring/actions/workflows/ci-cd.yml)
[![CodeQL Advanced](https://github.com/Homemade-Cookies/Aspiring/actions/workflows/codeql.yml/badge.svg)](https://github.com/Homemade-Cookies/Aspiring/actions/workflows/codeql.yml)
[![Microsoft Defender For Devops](https://github.com/Homemade-Cookies/Aspiring/actions/workflows/defender-for-devops.yml/badge.svg)](https://github.com/Homemade-Cookies/Aspiring/actions/workflows/defender-for-devops.yml)

## Overview

Aspiring is a project designed to provide a comprehensive solution for managing and monitoring distributed applications. It includes features such as health checks, service discovery, resilience, and OpenTelemetry integration.

## Setup Instructions

To get the project up and running, follow these steps:

1. Clone the repository:
```sh
git clone https://github.com/yourusername/aspiring.git
cd aspiring
```

2. Build the project:
```sh
dotnet build
```

3. Run the project:
```sh
dotnet run --project Aspiring.AppHost
```

4. Run the tests:
```sh
dotnet test
```

5. Access the health checks UI:
```sh
http://localhost:8080/healthchecks-ui
```

6. View the Grafana dashboard:
```sh
http://localhost:3000
```

## Usage Examples

Here are some examples of how to use the project:

- To access the health checks UI, navigate to `http://localhost:8080/healthchecks-ui`.
- To view the Grafana dashboard, navigate to `http://localhost:3000`.

## Contribution Guidelines

We welcome contributions from the community! To contribute, please follow these guidelines:

1. Fork the repository and create a new branch for your feature or bugfix.
2. Write tests for your changes.
3. Ensure all tests pass.
4. Submit a pull request with a clear description of your changes.

## Technologies and Frameworks Used

- .NET 8.0
- ASP.NET Core
- OpenTelemetry
- Prometheus
- Grafana
- HealthChecksUI