Skip to content

gayankanishka/budgetly-api

Repository files navigation

Budgetly API

Budgetly is a RESTful API to mange personal budget flow. This repository only contains the backend of this application. Frontend resides on a separate repository. API was built with .NET 6 and PostgreSQL. You can use the InMemory database as well (controlled from the appsettings). Built according to the CQRS pattern and clean architecture. This was done as a part of a MSc module project.

Diagrams and other screenshots

Repository contains only the API module

Dashboard

dashboard

High-level architecture diagram

alt text

Endpoints

endpoints

What's included:

Table of Content

Quick Start

After setting up your local DEV environment, you can clone this repository and run the solution.

Prerequisites

You'll need the following tools:

Development Environment Setup

First clone this repository locally.

  • Install all of the the prerequisite tools mentioned above.

Build and run from source

With Visual studio: Open up the solutions using Visual studio.

  • Restore solution nuget packages.
  • Rebuild solution once.
  • Run the solution.
  • Local swagger URL here.

License

Licensed under the MIT license.