johneastman / todo

A to-do list app
MIT License
0 stars 1 forks source link

TODO

A shopping/to-do list app in React Native. The purpose of this project is to rebuild my Shopper Android app in React Native, a modern mobile development framework that will also ensure my app is cross platform.

Helpful Resources

Setup and Run the App on an Android Device

Backend

This project has a backend component that must be setup before the app. Follow the instructions in this repo.

App

  1. Create a file in the root directory called env.json and add the following data:

    cat >> env.json <<EOF
    {
       "baseURL": "<BASE_URL>",
       "areTestsRunningOverride": false
    }
    EOF
    • BASE_URL is for the TODO Backend API.
  2. Download node:

    I use Brew:

    brew install node
  3. Run npm clean install:

    npm ci
  4. Download Android Studio.

  5. Setup development environment

  6. From this project's root directory, run:

    chmod +x start-app.sh
    
    ./start-all.sh
    • Note: May need to run npx react-native start instead.
    • Additional steps/resources can be found here.
  7. Stop the app and run the following script to update the icons and splash screen:

    chmod +x move_android_images.sh
    
    ./move_android_images.sh
    • NOTE: this script currently only works for Android.
  8. Restart the app (./start-app.sh), and the icon and splash screen should be updated.

Run Tests

Run npm test.