Skip to content

Latest commit

 

History

History
26 lines (22 loc) · 1.42 KB

README.md

File metadata and controls

26 lines (22 loc) · 1.42 KB
Raw

Daydream — Monorepo

Daydream - AI image generation and sharing app

Description

AI image generation and sharing app. This monorepo contains the mobile and web apps.

Getting Started

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

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