Skip to content

Latest commit

 

History

History
236 lines (212 loc) · 6.81 KB

README.md

File metadata and controls

236 lines (212 loc) · 6.81 KB
Raw
Poster

myKampung App with React Native

Bringing the heart of the village online
SUTD What the Hack 2022 Hackathon Submission - Social Activities & Games

Table of Contents

About

Motivation for the Project

With the advancement of technology, people are becoming increasinly isolated and stuck in their own world of devices. This is where we introduce the same technology to bring them back together!

With this app, we can bring back the Kampung Spirit of togetherness as some things are done best with the people around you.

Scope

React Native App - Navigation Structure, Authentication Flow, Screens

Database Backend - Firebase Integration, Email Authentication, User Details, Announcement Storage, Profiles

Groups - Chat Groups, Link Provider

Tech Stack

Client
Database

Features of the App

Email Authentication

    Registration - Firebase email auth

    ss
    Log in - Returning user

    ss

Configure Profile

    Configures and groups users according to postal code/ HDB Block

    Only if user has not already configured their profile

    ss

Announcement Screen

    Announcments for the whole block to see for ease of access to info with most recent annocunement at the top

    Allows community leaders to easily spread info

    ss

Create Announcement Modal

    Add new announcments to the board

    Detailing the announcment name, type (notice/event/warning), a short description and an image

    ss

Carpool & Food Delivery Groups

    Chat groups for carpooling & ordering food together - saves money

    ss

Profile Screen and Sign Out

    Make edits to profile

    ss
    Settings - sign out button

    ss

Getting Started

Prerequisites

  • Yarn
  • Expo account
  • NativeWind (TailwindCSS)
  • Firebase

Installation

Install yarn package manager and Node.js

Install Expo CLI

Mobile client app Expo Go to open the project on Android/IOS or any web browser will do

Running it

Clone the project

  git https://github.com/bentohset/sutdwth-mykampung.git
  cd sutdwth-mykampung

Install dependencies

  yarn

Run the server

  yarn start

Future Developments

    Authentication

    Implement Singpass authentication to automatically call user's location/ postal code

    Location

    Add option to choose between block or region (introduces condos and landed properties)

    Announcement Tabs

    Tabs to filter based on announcement types

    Groups

    Built-in chat groups and feature to split costs and pay through the app

    Profile and Settings

    To add more parameters

    Styling

    Clean up the app and introduce an appealing color scheme

The Team

Introducting Breakfast Search - the winners of the 2022 SUTD Hackathon Social and Games category

    Ansenn Lee
    Benjamin Toh
    Sriram
    Tay Jiun Yuan