Sprout

UMaine cos420 - Software engineering - group 3 repo Spring 2019

Dating app repositoy

Table of contents

• Installation
• Run the Application
  • Android
  • iOS
• Guidelines for Commits
  • New Branch/Switch Branch
  • Stage Changes
  • Commit Changes
  • Push Changes
• Team Members

Installation

Make sure you have installed Node.js and can run npm in the terminal or command line. Please also install yarn to make your life a lot easier. To check existing or installed Node.js environment open the terminal/command line and type in

node -v
npm -v
yarn -v

After that, clone the GitHub repository using

git clone https://github.com/Enoinoo/Sprout

Go into Sprout/ foler

cd Sprout

Then use this command to install required packages

yarn

You might have to install Expo CLI manually, using

npm install -g expo-cli

Run the Application

First start the application using

npm start

Make sure the connection mode is on Tunnel, then

Android

Download the Expo App, then scan the QR code in the terminal or command line through the app. Then you should be able to see the home screen on your device.

iOS

Press e in the terminal or command line, enter your email address or phone number, then follow the instructions.

Guidelines for Commits

By default, you will be on master branch. You should always keep your local repository up to date using

git pull

New Branch/Switch Branch

If you want to work on a new feature, create a new branch and do so there after keeping your local repo up to date (keep in mind that there are some naming conventions with branches, for example no spaces), using

git checkout -b [name_of_your_new_branch]

You can make sure you are on the correct branch using

git branch

If you already have a local branch and/or would like to switch between branches, use

git checkout [name_of_the_branch]

Stage Changes

After you have made some changes, you can see which files are altered using

git status

You can stage your files for commit using

git add [name_of_your_file_or_directory]

Keep in mind that the shortcut for staging all files is

git add -A

If you want to unstage some changes, you can use

git checkout -- [name_of_your_file]

You can always check the status again to see which files will be commited.

Commit Changes

To commit the changes to your local branch, the easiest way is to use

git commit -m "your message for the commit"

Keep in mind that multiple commits can be made locally before pushing to GitHub.

Push Changes

After that, pushing your local branch and commits can be done using

git push origin [name_of_your_branch]

Database Set-Up

MYSQL installation

Fllow the instructions here https://dev.mysql.com/doc/refman/8.0/en/installing.html to install the MYSQL server for your respective opperating system.

You may need to run

mysql

from the command line to set up an account for the first time.

Initializing the Database

From the command line, change into the DataBase folder and run

mysql -u [username] -p [password] < Scehma.sql

If you are using the defualt mysql configuration you will run

mysql -u root < Scehma.sql

This will set up the table and you will not need to deal with mysql from here on out and you can work from nodeJS.

Team Members

Enoch Lin
Matthew Loewen
Kody Moseley
Noah Monto
Andrew Piccirillo
Taidgh Robinson