Skip to content

Developer Documentation

HarperCC101 edited this page Apr 16, 2025 · 7 revisions

Aria's Budget Tracker

This document outlines how to replicate the development environment for Aria's Budget Tracker.

SDKs & Tools

  1. Install .NET SDK Version 8: Download and install the .NET SDK 8 from the official Microsoft page: .NET SDK.
  2. Install Git: Download and install Git from the official Git website: Git.

Clone the Repository

Run the following command to clone the repository to your local machine:

git clone https://github.com/HarperCC101/CS690-FinalProject.git

Testing the Application

  1. Run the following command to clone the repository to your local machine:

    git clone https://github.com/HarperCC101/CS690-FinalProject.git
  2. Navigate to the directory containing CS690-FinalProject.

  3. Navigate to the repository Root directory:

    cd CS690-FinalProject
  4. Navigate to the repository Test directory:

    cd Test
  5. Run the test command:

    dotnet test

If you see "Passed!" and a summary of passing tests, you have successfully set up the development environment.

Running the Application

  1. Run the following command to clone the repository to your local machine:

    git clone https://github.com/HarperCC101/CS690-FinalProject.git
  2. Navigate to the directory containing CS690-FinalProject.

  3. Navigate to the repository Root directory:

    cd CS690-FinalProject
  4. Navigate to the repository BudgetApp directory:

    cd BudgetApp
  5. Run the run command:

    dotnet run

Development

The master branch of this repository is protected, so direct commits are not allowed. To contribute to the project, please follow these steps:

  1. Create Branch
  2. Make Changes
  3. Test Locally
  4. Commit & Push Branch
  5. Create Pull Request

Making a Release

Navigate to the repository root:

cd CS690-FinalProject

Publish the Application:

dotnet publish

Create a zip archive of the published files:

zip -r my-budget-app.zip *

Publish Release.

Clone this wiki locally