Skip to content

Quick Start

Prerequisites

  • .NET 9 SDK (9.0+)
  • SQL Server, PostgreSQL, MySQL or SQLite
  • (Optional) Docker Desktop for the full dev environment

Installation

bash
# Clone the repository
git clone https://github.com/khalilbenaz/RIVORA.git
cd RVR.Framework

# Restore packages
dotnet restore

# Run the API
dotnet run --project src/RVR.Framework.Api

The API starts at http://localhost:5220.

Available Endpoints

EndpointURL
REST APIhttp://localhost:5220
Swagger UIhttp://localhost:5220/swagger
ReDochttp://localhost:5220/api-docs
Health Checkhttp://localhost:5220/health
Admin Blazorhttp://localhost:5200

First Steps

1. Create a user

bash
curl -X POST http://localhost:5220/api/v1/auth/register \
  -H "Content-Type: application/json" \
  -d '{
    "email": "admin@example.com",
    "password": "P@ssw0rd!123",
    "firstName": "Admin",
    "lastName": "Rivora"
  }'

2. Login

bash
curl -X POST http://localhost:5220/api/v1/auth/login \
  -H "Content-Type: application/json" \
  -d '{
    "email": "admin@example.com",
    "password": "P@ssw0rd!123"
  }'

The response contains a JWT accessToken and a refreshToken.

3. Call the API

bash
curl http://localhost:5220/api/v1/products \
  -H "Authorization: Bearer <your-token>"

Docker Compose

To start the full environment (SQL Server, PostgreSQL, Redis, RabbitMQ, Prometheus, Grafana, Jaeger, Seq):

bash
docker compose -f docker-compose.dev.yml up -d

Available services:

ServicePortUI
SQL Server1433-
PostgreSQL5432-
Redis6379-
RabbitMQ5672http://localhost:15672
Prometheus9090http://localhost:9090
Grafana3000http://localhost:3000
Jaeger16686http://localhost:16686
Seq5341http://localhost:8081

Next Steps

Released under the MIT License.