Giter Club home page Giter Club logo

comapeo-mobile-github-actions's Introduction

CoMapeo Mobile

New update to test differences

Getting started

  1. Clone repository

    git clone https://github.com/digidem/comapeo-mobile.git
  2. Set up the development environment

    1. Install Node, ideally through a proper node version manager such as nvm, fnm, asdf, or mise

      • This project uses Node v20 with npm v10
    2. Follow the React Native instructions for setting up the development environment: https://reactnative.dev/docs/environment-setup

      • Note that Java 17 is the minimum version required for this project.

      • When setting up the Android-specific tooling, you will also need to install the Android NDK. This can be installed using Android Studio by going to the SDK Tools tab in the SDK Manager. This project uses NDK 25.1.8937393.

    3. Create a .env file at the root of the project with the following content:

      MAPBOX_DOWNLOAD_TOKEN=<your_token_here>
      EXPO_PUBLIC_METRICS_URL=<metrics URL>
      EXPO_PUBLIC_METRICS_API_KEY=<metrics API key>
      

      Replace <your_token_here> with a Mapbox secret token. This is unfortunately required to install the necessary Mapbox Android SDK components used by @rnmapbox/maps@10 when building the app (more info here). If you do not have access to a Mapbox account, reach out to the maintainers about getting access to a secret token.

  3. Run the app locally

    1. Install dependencies

      • This project requires the following system dependencies. Make sure they are available on your PATH.

        • curl
        • tar
      • Install NPM-based project dependencies

        npm install
    2. Generate the native code

      • This project uses Expo Prebuild for generating the relevant native code. If you update app.json or app.config.js, or install/update any dependencies that provide native code, you should run the following command to make sure the project is up-to-date:
      npx expo prebuild

      If you have made any manual changes to the generated directories (e.g. android/ or ios/), you may need to specify the --clean flag with the command.

    3. Start the Metro bundler process

      npm start

      Leave this running in a separate terminal window.

    4. Build and run the app (Android)

      • For this project, using a physical device is more convenient and reliable to work with. It is recommended that you follow React Native's setup instructions for running an app on a device.

      • Run the following command to build the backend and then build and run the Android app:

        npm run android

        If you do not need to rebuild the backend on subsequent runs (e.g. no changes in the src/backend/ directory), you can use the following command instead:

        npm run android-no-backend-rebuild

E2E Testing

This project is tested with BrowserStack.

comapeo-mobile-github-actions's People

Contributors

eriksin avatar achou11 avatar evanhahn avatar cimigree avatar bohdanprog avatar gmaclennan avatar cdfn avatar lightlii avatar digidem-bot avatar tomasciccola avatar ximenabb avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.