SC2006 Software Engineering Project — Homey

The one-stop-shop property market web application for Singapore

• Demo / Teaser
• Website
• Documentation

---

🎋 Environments

Environment	Github branch	URL
Production	main	https://homey-sg.vercel.app/
Staging	staging	https://homey-beta.vercel.app/

🛠️ Installation and Set Up

• Clone repository

  git clone [email protected]:crystalcheong/homey.git
  

• Install dependencies

  • PNPM

    pnpm install
    

  📦 Other package managers

  
  

  • NPM

  npm install
  

  
  

  • Yarn

  yarn install
  

  
  

• Environment Variables

  • Duplicate .env.example to create *.env files
    • .env — The default file used to store your dev, production, and test variables
    • .env.local — Overrides all environment files except the test file (including the default .env file)

• Preparing Prisma

   pnpm prisma:update
   pnpm prisma:prepare
  

• Starting the application

  • The application will start at http://localhost:3000 by default

     pnpm dev
    

---

📂 Project Structure

📦homey-webapp
 ┣ 📂prisma
 ┣ 📂public
 ┣ 📂src
 ┃ ┣ 📂components
 ┃ ┣ 📂pages
 ┃ ┣ 📂styles
 ┃ ┣ 📂utils
 ┣ 📂tests
 ┣ 📜README.md

/prisma - contains the Prisma schema and migrations
/public - stores static assets such as images, fonts, etc
/src - contains the source code of the application, segmented into different subfolders such as components, pages, styles, etc
/src/components - contains reusable UI components that are used across the application, such as buttons, forms, and navigation bars
/src/pages - each file in this directory represents a route in the application and is responsible for rendering the content of that route
/src/styles - stores global styles that are used across the entire application.
/src/utils - contains helper functions and utilities that are used across the application.
/lib - contains the project dependencies
/tests - contains end-to-end test scripts and result logging

---

🧰 Languages & Tools

• Languages & Frameworks
  

• Tools, IDE
  

---

Contributors ✨

Crystal Cheong

Chan Ming Han

Ng Mu Rong

Ang Jun Koon

Cheong Chi Hian

---

This repository is submitted as a project work for Nanyang Technological University's SC2006 - Software Engineering course.