Skip to content

Latest commit

 

History

History
109 lines (74 loc) · 5.17 KB

README.md

File metadata and controls

109 lines (74 loc) · 5.17 KB

Dispatch · GitHub license

Dispatch is a React Native application for managing Dispatch worker jobs in GpsGate.

  • Cross platform: The business logic of the app leverages the React Native framework and is written in platform-agnostic JavaScript with minimal use of native code. This means that new features and fixes only need to be applied in one place to target both iOS and Android. The app features platform specific user interfaces to make sure that workers get the experience they expect from their chosen mobile platform.
  • Event-driven: Dispatch uses an event driven design pattern featuring push based server communication, rxjs driven model updates and redux-saga to manage its side effects.
  • Offline capable: The app keeps track of all changes that the user makes while operating offline and synchronises its data with the server at the first available opportunity

Getting Started

These instructions will get you a copy of the project up and running for development and testing purposes.

Prerequisites

You will need to have Node installed on your development machine to build and run tests

You must install the React Native CLI globally after installing Node.

npm install -g react-native-cli

Installing

Clone the dispatch-app repository to your local machine

mkdir gpsgate
cd gpsgate
git clone https://github.com/gpsgate/dispatch-app.git
cd dispatch-app
npm install

Developing

Once you have installed Node on your machine you will need to set up an app development environment.

Development on dispatch-app can be done in your web development IDE of choice. All business logic and UI code is written in JavaScript and JSX. We develop using Visual Studio Code.

If you have Visual Studio Code installed, make sure you are still in the dispatch-app directory and write

code .

If you would like to run the project to test on an emulator or a device, you will need to follow the instructions below. The Android app can be compiled and run on Windows, Linux and MacOS. The iOS app can currently only be compiled and run on MacOS.

Running the tests

To run the tests on your development environment, make sure you are in the dispatch-app directory and use the command

npm run test

To run the code quality check use the command

npm run eslint

To make sure that the code is formatted correctly use the command

npm run prettier

Code of Conduct

GpsGate applies the contributor covenent code of conduct that we expect project participants to adhere to. Please read the full text so that you are aware of the standards of behaviour we expect on our Github repositories.

License

Dispatch is MIT licensed.

Built With