Skip to content

Monorepo Setup

Luke Dinh edited this page Mar 30, 2024 · 3 revisions

1) Clone Repository

  • I highly recommend you place the monorepo in a directory that is easy to find like Documents or a dedicated coding project folder if you have one.
  • For MacOS users, open Terminal if it isn't open already. For Windows users, open Git Bash as Administrator.
  • Run cd ~/Documents (or change directories into where you want to put Icebreak) with the following line below right after.
git clone https://github.com/cppsea/icebreak
  • There should be a new folder called icebreak.

2) Install Yarn

  • Since our repo uses Yarn Workspaces, we must use yarn as our package manager.
  • IMPORTANT. Don't use npm for this project or it will cause problems with our dependencies. We use Yarn for this project, not npm.
  • Enable corepack with corepack enable.
  • Install Yarn with corepack install while in Icebreak's root directory.

3) Install Package Dependencies

  • Run yarn while inside the Icebreak repo folder, this will install all required dependencies needed for both client and backend node_modules.
  • If you run ls on the icebreak's directory, it should have a directory called node_modules.