暂无描述

chase a7e0804454 more refactors 2 年之前
.expo-shared 2c36d63256 Created a new Expo app 3 年之前
__tests__ c25c25918b starting adding mobx, changing file structure and extracting logic 2 年之前
android c25c25918b starting adding mobx, changing file structure and extracting logic 2 年之前
assets c25c25918b starting adding mobx, changing file structure and extracting logic 2 年之前
coverage c25c25918b starting adding mobx, changing file structure and extracting logic 2 年之前
design 5e63c689ad updated docs 3 年之前
docs c25c25918b starting adding mobx, changing file structure and extracting logic 2 年之前
ios c25c25918b starting adding mobx, changing file structure and extracting logic 2 年之前
oss-attribution c25c25918b starting adding mobx, changing file structure and extracting logic 2 年之前
src a7e0804454 more refactors 2 年之前
test c25c25918b starting adding mobx, changing file structure and extracting logic 2 年之前
.env 60aa449ce1 fixed zoom issue 2 年之前
.gitignore b291e89433 resetting repo, trying to add detox 2 年之前
App.tsx c25c25918b starting adding mobx, changing file structure and extracting logic 2 年之前
GoogleService-Info.plist c25c25918b starting adding mobx, changing file structure and extracting logic 2 年之前
app.json c25c25918b starting adding mobx, changing file structure and extracting logic 2 年之前
babel.config.json c25c25918b starting adding mobx, changing file structure and extracting logic 2 年之前
declarations.d.ts c25c25918b starting adding mobx, changing file structure and extracting logic 2 年之前
docker-compose.yml fe6473aa91 finished landmark photos 2 年之前
google-services.json c25c25918b starting adding mobx, changing file structure and extracting logic 2 年之前
index.js c25c25918b starting adding mobx, changing file structure and extracting logic 2 年之前
jest.config.js c25c25918b starting adding mobx, changing file structure and extracting logic 2 年之前
jsdoc.json c25c25918b starting adding mobx, changing file structure and extracting logic 2 年之前
metro.config.js c25c25918b starting adding mobx, changing file structure and extracting logic 2 年之前
package-lock.json c25c25918b starting adding mobx, changing file structure and extracting logic 2 年之前
package.json c25c25918b starting adding mobx, changing file structure and extracting logic 2 年之前
privacy.html c25c25918b starting adding mobx, changing file structure and extracting logic 2 年之前
readme.md c25c25918b starting adding mobx, changing file structure and extracting logic 2 年之前
tsconfig.json c25c25918b starting adding mobx, changing file structure and extracting logic 2 年之前
tsconfig.spec.json c25c25918b starting adding mobx, changing file structure and extracting logic 2 年之前
usage.html c25c25918b starting adding mobx, changing file structure and extracting logic 2 年之前
yarn-error.log bfc9e9c427 enhanced vtt 3 年之前
yarn.lock c25c25918b starting adding mobx, changing file structure and extracting logic 2 年之前

readme.md

Click & Push Mobile

Click&Push's mobile app, built with React Native/Typescript. Acts as a client for Click & Push's Rest API.

Downloading and running the app

Reading the React Native CLI Quickstart guide on the official docs is highly recommended, however the process is very straight forward. https://reactnative.dev/docs/environment-setup

Click & Push Mobile uses Expo's Bare workflow, so it leverages Expo's powerful CLI, but also allows for essential native modules to be added (i.e. voice recognition)

General

  1. Clone the repository
  2. Make sure you have execute permissions set on your project folder sudo chmod -R 755 atlas-mobile-ts/
  3. Install node and npm if needed https://nodejs.dev/learn/how-to-install-nodejs
  4. Run npm install -g expo-cli if you don't have the expo-cli installed already.
  5. Run npm install to install dependencies from package.json.

After these steps, you need to perform some additional platform-specific steps (note: the ios and android folders in the repo have important modifications that enable certain dependencies in the app to function properly, so its important to keep them intact when pushing and pulling the repo):

Android

  1. Set up an android device (you'll need to use a physical device in order to use the voice to text capabilities), go here if you need information on how to set up a physical device for development.
  2. Install and configure the a compatible JDK and android SDK (go here and choose React Native CLI Quickstart -> <your OS> -> Android for comprehensive instructions on how to do that).
  3. Check the atlas-mobile-ts/android/build.gradle file to make sure that compileSdkVersion and targetSdkVersion are set to the Android API level that matches your device (i.e. Android 12 = API 31)
  4. Run expo run:android in the app root folder, which will install the app on your device and run it.

iOS

  1. Set up an iOS device (you'll need to use a physical device in order to use the voice to text capabilities), go here if you need information on how to set up a physical device for development.
  2. Install and configure the Xcode and cocoapods (go here and choose React Native CLI Quickstart -> macOS -> iOS for comprehensive instructions on how to do that)
  3. It is recommended run the project using xcode, as it will provide some extra code quality checks.

For technical information about the project structure and explainations of the code, see the wiki.