Mobile client for FireAPI, Version 1

That which is not measured, cannot be managed. Get to know your circadian rhythmn by tracking your alertness levels throughout the day.

Back-end: https://github.com/yffenim/fire_api

Features

• Track alertness levels on scale of 1-9 with times rounded to the hour
• Track up to two other models
• Display recently created data so one can edit or delete
• View daily summary graphs of individual models
• User authentication
• OAUTH integration

Instructions for Use

Clone the repo: git clone https://github.com/yffenim/fire_native.git

Navigate to the project directory.

When you run the install command, you may see a lot of warnings. Please do not run npm audit as suggested even if the vulnerabilities are "high"

npm install from within project directory

npm start

OR, if this is not your first time running this project, please use: npm start --reset-cache

Note that many features, such as emailing the CSV or scrolling through an extended view will not work on browser.

Using mobile

Download onto your phone:

Expo for Android (Google Play Store Link: https://play.google.com/store/apps/details?id=host.exp.exponent)

or Expo for iOS (App Store Link: https://itunes.apple.com/us/app/expo-client/id982107779)

Scan the QR code from the terminal from your camera. Expo will load project automatically. Shake your phone to reload.

Using Simulator

i for IOS stimulator

r to reload if nothing is happening after 10 seconds of it loading.

You will see a terminal message indicating that the bundling is happening if it is loading.

Using browser

Follow the instructions from your terminal.

General Troubleshooting

r to reload.

npm start --reset-cache

npm upgrade

If you have used yarn to install any dependencies, please remove the yarn.lock and re-install modules with npm.

If there are still cache issues, please try:

(Note that if you do not have watchman installed or if your DIR is slightly different, you may have to install watchman and/or modify the exact command you use.)

watchman watch-del-all

rm -rf $TMPDIR/react-native-packager-cache-*

rm -rf $TMPDIR/metro-bundler-cache-*

rm -rf node_modules/

npm cache clean --force

npm install && npm start --reset-cache

Development Troubleshooting

If any navigation stack changes have been made, you must restart the server: npm start --reset-cache

If more than 75 requests have been made to the FIRE API, you will have to wait for the next hour.

Note that the rendering on native vs browser may be different. It is useful to check browser version if native display is empty without reason. Browser dev tools are also useful for full error message rendering.

Network issues: Easiest to use https://proxyman.io/ on your IOS to capture requests. (This is different from proxyman.)

Development Docs

Repo Hierarchy

Root Level

app.jsx -> entrypoint.

helpers -> function helpful to development, not neccesary to app itself.

__tests__ -> testing via jest. Use npm run test.

SRC level

src
|---assets
|---containers
|---functions
|---presentations
|---screens
|---styles

assets -> static assets

containers -> how things work; stateful components; provides data and behaviour; minimal styling but will have wrapping elements or JSX will be unhappy

functions -> functions used by containers or presentations, including API calls

presentation -> how things look; stateless components; mostly pure functions (gauranteed to return the same result given the same props and state); no deep mutations/

screens -> the "pages" of the native app. Top level: LandingScreen.jsx

styles -> self-explanatory

Component hierarchy

Level 1. [LandingScreen]

Level 2. [UserScreen],[AddDataScreen],[SummaryScreen],[ExportScreen]

Detailed diagram coming soon.

Thank you