Life List App

Table of Contents

1. About the Project
   • Built With
2. Getting Started
   • Installation
   • Installed Packages
   • Updating Version
3. Linting & Testing

4. Report an Issue

5. Created By

About the Project

Life List is a mobile application where a birder can track their cumulative record of bird species that they have successfully identified.

Built With

This application is built with a react-native front-end.

• React Native

Getting Started

This application was created using React Native, you can follow their Setting up the development environment guide to get started.

Note: This application was created using React Native CLI Quickstart

Installation

1. Clone this repo

git clone git@github.com:isaiahcolson/lifelistapp.git

2. Install npm packages

npm install

# or you can run
npm i

3. For iOS

cd ios
pod install

4. You will be missing the dotenv file with the GOOGLE_TOKEN value, ask the code owner for that value.
5. You will also be missing the google-services.json file and will need to ask the code owner for that.
6. Start the application

# if you have npm
npm start

# if you have yarn
yarn start

# alternate version for either yarn or npm
npx react-native start

5. Run your device(s)
   

# run an iOS simulator
npm run ios

# run an android emulator
npm run android

Note: Android Studio must be installed to run and Android emulator and XCode must be installed to run an iOS emulator

Installed Packages

• React Navigation
• React Native Tab Navigation
• React Native Firebase
• React Native Google Sign In
• React Native dotenv
• Cloud Firestore

Updating Version

Follow the npm-version standards for a version bump chore.

# 1.0.0 -> 1.0.1
npm version patch

# 1.0.0 -> 1.1.0
npm version minor

# 1.0.0 -> 2.0.0
npm version major

Note: All version bumps should be accompanied by a Github release.

Linting & Testing

ESLint

This application uses ESLint which is a static code analysis tool for identifying problematic patterns found in JavaScript. Use the following commands to run ESLint on all .js files in root:

# if you have yarn
yarn lint

Jest

This application uses Jest which is a testing framework designed to ensure correctness of any JavaScript codebase. Use the following commands to run this project's tests:

# if you have npm
npm test

# if you have yarn
yarn test

Report an Issue

If you have a bug or an idea, browse the open issues before opening a new one.

Created By

• Isaiah Colson - @isaiahcolson
• Project Link