2006-SCSB-SCSB-T2 / Sweet Home Finder

Filter home locations by desired amenities and frequently visited locations
Never be too far from the places you love

• Demo
• Documentation

🛠 Installation and Setup

Starting the server and client on Windows:

.\start.bat

Starting the server and client on Mac/Linux:

./start.sh

Starting the server:

cd backend
npm install
npm run start:dev

Starting the client:

cd frontend/client
npm install
npm start

📂 Project Structure

View project structure

📦2006-SCSB-SCSB-T2
 ┣ 📂backend
 ┃ ┣ 📂node_modules
 ┃ ┣ 📂dist
 ┃ ┣ 📂src
 ┃ ┣ 📂test
 ┃ ┗ 📂services
 ┣ 📂frontend
 ┃ ┣ 📂client
 ┃ ┃ ┣ 📂build
 ┃ ┃ ┣ 📂node_modules
 ┃ ┃ ┣ 📂public
 ┃ ┃ ┣ 📂src
 ┃ ┃ ┃ ┣ 📂components
 ┃ ┃ ┃ ┗ 📂pages
 ┗ 📜README.md

/backend/node_modules - contains modules used in the backend code
/backend/src - contains the source code of the application, segmented into different subfolders
/backend/dist - stores the backend compiled TypeScript
/backend/tests - contains end-to-end test scripts and result logging

/frontend/public - stores static assets such as images, fonts, etc
/frontend/build - stores the frontend compiled build
/frontend/node_modules - contains modules used in the frontend code
/frontend/src/components - contains reusable UI components that are used across the application, such as buttons, forms, and navigation bars
/frontend/src/pages - each file in this directory represents a route in the application and is responsible for rendering the content of that route

🧰 Languages & Tools

• Languages & Frameworks
  

• Tools & Platforms
  

• Database
  

• User Interface
  

• APIs and Data
  

  • Google Maps API
  • Data.gov.sg

Contributors ✨

Wu Ji

Sean

Harry

Boon Yi

Alyssa

Jeremy

---

This repository is part of a project for NTU SC2006.