Skip to content

Latest commit

 

History

History
54 lines (41 loc) · 1.5 KB

README.md

File metadata and controls

54 lines (41 loc) · 1.5 KB
Raw

TECH REQUIREMENTS

  • React 18 ✅
  • Typescript ✅
  • Deck.GL ✅
  • Mapbox ✅
  • Turf.Js ✅
  • Mui 5 ✅
  • Jest ✅

DEPLOYMENT

Project is deployed on Vercel

URL: https://map.muum.dev

DEVELOPMENT PROCESS

Architecture - Fundamental structural organization for software systems Design Patterns - Solves reoccurring problems in software construction

1] Architecture (What & Where)

  • The project will need 1 page: Map ✅
  • Upload (in the form of geojson) a plots ✅
  • Draw a building in the center of the plot ✅
  • Customize the properties of the building (floor area, number of floors and height per floor) with a Slider ✅
  • Display the statistics of the building ✅
  • Deploy to Vercel ✅

2] Design Pattern (What & How)

  • MapBox for map system ✅
  • Deck.gl for 3D building layer ✅
  • MUI for UI elements ✅
  • Atomic design system for component development ✅
  • Jest for unit testing ✅
  • ESLint recommended rules ✅
  • Seperate logic and view with the help of React Hooks ✅

GETTING STARTED (FOR THE ONES WHO CLONE THE PROJECT)

First, run the development server:

npm run dev
# or
yarn dev
# or
pnpm dev

Open http://localhost:3000 with your browser to see the result.

You can start editing the page by modifying pages/index.tsx. The page auto-updates as you edit the file.

This project uses next/font to automatically optimize and load Inter, a custom Google Font.