Roommated helps you connect with your roomates on the fly

Project technology overview

This is the monorepo for the Roommated project

• Frontend: Angular + TailwindCSS
• Backend: Nestjs + MySQL
• Package management: Yarn
• Monorepo management: Yarn workspace & Nx
• Devops: Azure

Setting up

1. Install some Global tool

npm install -g nx yarn @nestjs/cli typescript

2. Install project dependencies

After cloning the project, at the project's root:

yarn install

3. Add environment variables

Ask Devin for environment variables files and add them to the appropriate folders

4. Run the project

Some VsCode Tasks have been added to help you not having to type long commands:

1. Go to the "Terminal" menu on the top toolbar
2. Choose "Run Task"
3. Choose the appropriate tasks to run (Client Dev, Server Dev, or Dev)

If you prefer Command Line, specific commands can be found in the "package.json" of each app. Instructions on how to run these commands with yarn can be found in the Developer guides

The "shared/common" folder

The "shared" folder is for code that are to be shared between backend and frontend.

For example: Entity TS Interfaces, Local Urls, Common constants such as Project branding, etc.

Both "backend" and "frontend" have been configured to have included this "shared" dependency. Therefore, to import code from this "common" module, simply use:

import { User, Post } from "@rmtd/common/interfaces";
// Or when you have name conflicts, you alias import
import { User as UserInterface } from "@rmtd/common/interfaces";

Note that the name of the module is actually "common" and it is necessary to access the right level of subfolder after /common/

Developer guides

Guidelines to aid developers and contributors working on the project: Developer guides