Skip to content

Latest commit

 

History

History
33 lines (22 loc) · 1.93 KB

README.md

File metadata and controls

33 lines (22 loc) · 1.93 KB
Raw

Flat Management Program

The Flat Management Program is a web application designed to make it easier to manage flat (shared house) expenses. The program stores one-off and periodic expenses for a given flat, and helps keep track of who has paid those bills. You can also roster chores and share your timetable using the convenient webapp.

This project was created as part of the SOFTENG 701 course at the University of Auckland.

Technical Layout

The project consists of two main code bases: a backend (in WebApiBackend) and a frontend (in Frontend). The backend is a C# project providing a JSON API. The frontend is a ReactJS project that interacts with the API.

Before Contributing

Make sure you're aware of our license, contributor guidelines and branching policy.

Get Started!

To get the project running, follow these steps:

Prerequisites

  • Visual Studio (for editing C# code) [or the equivalent dotnet command line tools, or JetBrains Rider]
  • Make sure you've installed the ASP.NET and Web Development Tools package in Visual Studio
  • Visual Studio Code [or equivalent frontend tooling]
  • NPM/NodeJS (for running the frontend)

Steps

  1. Open the backend folder (WebApiBackend) and find the Solution (.sln) file, and open in Visual Studio.
  2. Once Visual Studio loads up, you should have a green "IIS Express" button to start the app in the top toolbar. Click it.
  3. It'll take some time the first run (as Visual Studio should install all dependencies). Once the backend server is running, a new window will open displaying Swagger, which is a tool used for testing the API endpoints.
  4. Open the frontend folder in a command line tool.
  5. Run npm install to download and install all dependencies.
  6. Run npm start to start the React development server.
  7. Your browser should open (or you may have to open a link from the React command line tool). You should see the home page, and it should successfully connect to the backend.