Flat management made simple.

Features • Installation • Contributing • Documentation • Troubleshooting • Demo

Disclaimer

This is a project for the University of Auckland SE701 course (Team 4). It will likely not be maintained after completion of this course.

Screenshots

Key Features

• Bill Splitting
• Chores Management
• Synchronised Notes

Installation

To clone and run this application, you'll need Git, Node.js 16.x, Yarn and MongoDB installed on your computer. From your command line:

# Clone this repository
$ git clone https://github.com/701-T4/flatshare

# Go into the repository
$ cd flatshare

# Install dependencies
$ yarn install

# Run the app
$ yarn start

by default your application will be hosted at http://localhost:3000, while the api will be hosted at http://localhost:4200/api. These can be changed in the config/environment values.

Running Tests

To run tests, run the following command

  yarn test

Docker

A docker image has been provided that contains a full environment for running the application in. It can be used to quickly start running the app on any operating system.

Ensure you have set up backend env files first. Checkout backend README for more info.

# Run Web App
yarn start:docker

# Run Tests
yarn test:docker

Contributing

Contributions are always welcome!

See CONTRIBUTING.md for ways to get started, as well as more detailed instructions on setting up and working with the repository.

Please adhere to this project's code of conduct.

Documentation

This project is using GitHub wiki for documentation.

Swagger API documentation is available on /api for the backend. This can be found here for the currently deployed backend.

Tech Stack

Client: React, TailwindCSS, NextUI

Server: Node, NestJS, mongoose

License

MIT