[go: up one dir, main page]

Skip to content

mazchew/find-my-item

Repository files navigation


FindMyItem

A better, easier lost and found application for NUS.
Explore our README »

View Demo

Table of Contents
  1. About The Project
  2. Getting Started

About The Project

Through our experience with using the NUS Lost and Found website, we noticed how difficult it was to identify whether an item on the website was the one we lost. There is only a short generic text description of the lost item and thus we had to go down to the lost and found point to identify the item. We believe that a better interface could be created to reduce the hassle for people who have lost items on campus.

Our goal for our Orbital project is to create a one stop site for users who have found a lost item and users who are looking for a lost item. We hope to reduce the hassle and time taken to search for a lost item. Our platform’s Gallery page displays items that have been found in an intuitive manner with images. In addition, our platform also has a Noticeboard which allows users to post items they have lost.

In short, our platform helps people recover their lost items in the shortest possible time with an easy-to-use and intuitive web application that caters to both users who lost their personal items, as well as users who found misplaced items.

(back to top)

Built With

  • Next
  • React
  • Vercel
  • TailwindCSS
  • Supabase
  • Prisma
  • Jest

(back to top)

Getting Started

To get a local copy of FindMyItem up and running follow these simple example steps:

Prerequisites

Install all dependencies

  • npm
    npm install npm@latest -g

Installation

  1. Get free API Keys for SendGrid and Supabase
  2. Clone the repo
    git clone https://github.com/mazchew/find-my-item.git
  3. Install NPM packages
    npm install
  4. Enter your API keys in the .env file

(back to top)