Split-It

Orbital Project - Bill splitting app with incorporation of OCR feature


Project maintained by ngzhaoming Hosted on GitHub Pages — Theme by mattgraham

Split-It user guide

Table of contents

1. General Information
        1.1 System overview
        1.2 Organization of READ.me

2. Getting Started
        2.1 Installation of Split-It

3. Using Split-It
        3.1 Account Creation
        3.2 Features of Split-It
                3.2.1 Splitting Methods
                3.2.2 OCR recognition
                3.2.3 Financal Tracker
        3.3 Administrative matters
        3.4 Help and support

4. Feedback and Contact us
        4.1 Contact us


1. General Information

1.1 System overview

Welcome to Split-It! Split-It is is a mobile application created using React Native which functions on both Android and iOS devices. Ever felt that bill-splitting of sharing meals with your friends, or settling utility bills with your other room mates a chore? Worry no more cause Split-It is here to convenience your life! With Split-It, it will help facilitate your bill-splitting activities and ensure that everyone pays their share hassle free! What are you waiting for? Get a copy of your Split-App application today!

1.2 Organization of READ.me

The user’s manual consists of 4 sections: General Information, Getting Started, instructions on how to use Split-It and Feedback and Contact us.

Section Description
General Information Gives a broad overview of what Split-It does and the
purpose for which it is intended
Getting started Instructions to installing Split-It and the commands
to run the application
Using Split-It Gives a step-by-step instruction on how to use
the features in Split-It
Feedback / Contact Provide information to contact the creator of Split-It

2. Getting started

2.1 Installation of Split-It

To get your very own of Split-It, go to my GitHub Split-It repository. At that page, click the button clone or download and download the zip file. Open up Terminal (macOS) or Command Prompt (Windows) and navigate to the repository directory that was downloaded.

  1.  Download Expo application onto your phone and create an account in the Expo app
  2.  From the terminal that you are using, go to the directory Split-It master located  within the repository.
  3.  Install the node modules for this application first by typing npm install
  4.  Once the installation for the node modules is done, type expo start to open up the  metro bundler and run the app. A QR code will be made available in metro bundler.
  5.  Open your phone’s camera and use it to scan the QR code provided in the metro  bundler.
  6.  A prompt from Expo will be shown on the top of the screen.
  7.  Select it to allow Expo to access the Split-It app.

Once you are directed to the login page, create an account using the signup button below and feel free to try out the features that are available for Split-It application.


3. Using Split-It

Here is a video guide which showcase an overview on the features made available on Split-It. This step-by-step video will show you on how to create accounts up till using the features that are made available in Split-It to facilitate your bill-splitting activites.

3.1 Account Creation

Upon starting up Split-It application on the expo app, you will first be greeted with Split-It login page. Click on the sign up link at the bottom to be directed to the sign up page. After selecting the choice of language, register a Split-It account using your email and password. A verification email will be sent to you to verify your email.

Proceeding on from the previous page, you will be able to customize your profile, by inserting a profile picture and also entering your phone number. Once done, users will be immediately directed to the Split-It homepage where they can start using those cool features implemented.

3.2 Features of Split-It

3.2.1 Splitting Methods

Split-It application supports two forms of splitting methods. To start a bill-splitting activitiy, click on the black SPLIT button located in the homepage. Users will be directed to the contact page. Split-It will sync the user’s contact page on their phone and filter out only other registered users to be shown. Select the contacts whom are involved in the bill-splitting activity and select proceed.

3.2.2 OCR recognition

The OCR recognition feature is implemented using Google Vision Cloud API. It is mainly used for the receipt bill-splitting method. Upon navigating to the receipt tab, users will be directed to a page where they can upload a photo through their Gallery or use their in-built camera to take a picture of the receipt. Once the picture has been uploaded, the Analyze button will appear. Click on it for Split-It to process the picture of the receipt. Once the data has been shown, click on Proceed for Split-It to process the receipt details.

Users will be directed to the splitting page where the total amount of the receipt will be automatically inserted into the Total Amount field. Users are recommended to categorize their bill-splitting activity so that the Split-It can help track their individual spendings.

3.2.3 Financial Tracker

The financial tracker is located in the homepage of Split-It application. It keeps tracks of the user’s spendings based on the different categories:

When adding a new bill-splitting activity, users are prompted to categorized their activity so that Split-It can use these data to keep a track record of the user’s spendings.

3.3 Administrative matters

Under the more tab in the homepage, users are able to edit their account. They can select the profile tab which allows them to change their:

These accounts are managed through Google Firebase RealTime Database.

3.4 Help and support

Also under the more tab in the homepage, users can select the Help and FAQ section to view some of the potential problems that they can face while using Split-It application. This will be followed up with a guide on how to address these issues for a smoother experience with Split-It.

The help and FAQ feature are categorized into two sections, app help which covers the functionality aspects of Split-It while FAQ covers the common errors and bugs that users can potentially face while using Split-It.


4. Feedback and Contact us

4.1 Contact us

Thank you for using Split-It. Feel free to drop the developer a feedback in order to improve Split-It application further! I can be connected through the following channels:

  1. Github
  2. Instagram
  3. LinkedIn
 ________  ________  ___       ___  _________             ___  _________   
|\   ____\|\   __  \|\  \     |\  \|\___   ___\          |\  \|\___   ___\ 
\ \  \___|\ \  \|\  \ \  \    \ \  \|___ \  \_|__________\ \  \|___ \  \_| 
 \ \_____  \ \   ____\ \  \    \ \  \   \ \  \|\__________\ \  \   \ \  \  
  \|____|\  \ \  \___|\ \  \____\ \  \   \ \  \|__________|\ \  \   \ \  \ 
    ____\_\  \ \__\    \ \_______\ \__\   \ \__\            \ \__\   \ \__\
   |\_________\|__|     \|_______|\|__|    \|__|             \|__|    \|__|
   \|_________|