/daydream

Primary LanguageTypeScriptMIT LicenseMIT

DaydreamMonorepo

Description

This is the monorepo with the mobile and web apps for the Large Project.

Getting Started

Structure

The general hierarchy of the project is as follows:

.
├── mobile   (The mobile app, built with React Native and Expo)
└── web      (The web app and API, built with Next.js)

Prerequisites

  1. Download and install Node Version Manager > (Windows | macOS/Linux)
  2. Install and run the latest node version by running nvm install 18 && nvm use 18 in the terminal
  3. Install Yarn by running npm install -g yarn
  4. Go to the directory of the project you'll be working in and run yarn to install all dependencies

Starting the web app in a development environment

  1. Ensure you are in the directory for the web app cd ./web and run yarn dev to boot it up
  2. The app should now be running at http://localhost:3000

Starting the mobile app in a development environment

(Soon™)

Committing changes

  1. Ensure there are no errors by running yarn lint and yarn test in the respective app's directory
  2. Commit your changes using git commit -m "<type>[scope]: <description>" (Please follow Conventional Commits) and push them to the remote repository using git push