Skip to content

Latest commit

 

History

History
66 lines (46 loc) · 2.43 KB

README.md

File metadata and controls

66 lines (46 loc) · 2.43 KB
Raw

image


NotReal is a React Native and Expo application and an incomplete clone of BeReal made as a demo originally designed for teaching the mobile development learnathon track at Blueprint 2023.

Overview

NotReal is split into three primary screens:

  • Initial: An initial screen which allows you to enter your handle
  • Feed: The main screen of the application which shows a feed of all NotReal posts made so far
  • Camera: A camera screen to make new posts

NotReal currently does not have a backend, but you can make one as an extra exercise at the end of the learnathon day! We recommend using a backend as a service such as Firebase or Supabase.

NotReal was also developed with mobile platforms in mind (iOS and Android), so it may/may not work on web or with an emulator.

File Structure

  • assets/ - All icons and static images are stored in this folder
  • components/ - Stores reusable React components which are not screens
  • contexts/ - Stores React context providers + hooks
  • data/ - Stores fake data used in application
  • navigation/ - Stores major React components used as alternate screens
  • App.js - Main/Entrypoint React component
  • app.json - Stores metadata for mobile application
  • package.json - Tracks dependencies used in application

Installation

Node.js

React Native and Expo uses Node.js as the underlying JavaScript runtime. Install Node.js version 18 from the web page.

Running

To run the application, first install dependencies then start it:

yarn install
yarn start

Additional Ideas

  • Add persistence + a database using Firebase
  • Add scheduled notifications using expo-notifications
  • Add phone authentication using Firebase
  • Add file uploading using Firebase

License

NotReal is licensed under MIT. You may use and distribute this source code as long as it follows the guidelines set by the license.