Skip to content

UTARi-Accommodation/web

Repository files navigation

UTARi Accommodation

A web application that was developed when I got frustrated with the official accommodation listing website provided by UTAR

However, I never get the change to actually use it because of MCO and soon it became my Final Year Project (FYP)

I must admit I could have proposed a more advanced title 😏

Usage

  1. Filter accommodations with price range, search bar, number of bath/bed rooms (unit-based) and room capacity(room-based)
  2. Rate and unrate any accommodation
  3. Bookmark and unbookmark any accommodation
  4. Download bookmarked accommodation into a text file
  5. Contact the handler of an accommodation through WhatsApp and/or email if there's any

Preview

Click to preview!

Main Page

Home

About Page

About

Contact Page

Contact

Accommodation Page (Room-Based)

Room Detailed Room

Accommodation Page (Unit-Based)

Unit Detailed Unit

How it Works Page

Work

Last but not least, footer

Footer

Tech Used

Aspect Name
Development Language TypeScipt
Bundling Vite
Testing Vitest
Styling Styled-components
Library React
Authentication Service Firebase
Build Automation Tool Make
Progressive Web App Workbox
Text Editor NeoVim
Dependency Management Pnpm
Continuous Integration, Continuous Delivery, and Continuous Deployment GitHub Actions

How to build this app?

Make sure you have pnpm and make available in your system

Environment Variables

Development and Testing

Refer to .env.example which is an example file for you to know what key-value pairs are needed to develop this project

Then, create an .env file that will be used for development and testing. Then copy the key-value pairs to it and then add the values

Make Commands

Below are the listed commands that you can use to build/develop/test this app

Command Usage
make start Start development
make test Run all test code
make build Bundle and build the app
make typecheck Run typechecking for source and test code
make lint Run linter for source and test code
make format-check Run prettier to check source and test code format
make format Run prettier to format source and test code
make install Install all dependencies