lineQueueManager

LineQueue - Manager

Mobile manager for the line queue application 🏪🕵️‍

Getting Started

In order to start the project, simply clone the repository, install the dependencies and initialize the react-native environment emulator

git clone https://github.com/shakedlokits/LineQueue.git && cd lineQueueManager
yarn
react-native run-<android|ios>

Prerequisites

For this project to run you must have the react-native installed and configured, for more information see ReactNative - Getting Started

Configuration

In order to build this project, place a config.js file in the root directory which resembles:

const config = {
    apiKey: <API Key>,
    authDomain: <Authentication Domain>,
    databaseURL: <Database URL>,
    projectId: <Project ID>,
    storageBucket: <Storage Bucket ID>,
    messagingSenderId: <Message Sender ID>
}
export default config

which links this project to your firebase instance, before you build these applications. More details on further configuration can be found Firebase Remote Config.

Running the tests

In order to run the tests, simply run

yarn test

Note: Our tests make use of Jest

Tests Structure

Each component is joined with a \*.test.js file which at least passes a smoke test on it's render function and additionally verifies custom functionality it performs(component life-cycle functions and methods)

For example, App.js holds the app entry point(surprisingly😏)

.
├── App.js
└── App.test.js

Thus App.test.js will hold a test suite for the entire file and sub-suite for the entry point

import 'react-native'
import React from 'react';
import renderer from 'react-test-renderer';

import App from './App';
it('renders correctly', () => {
  const app = renderer.create(
    <App />
  );
});

Building the project

In order to build the project for android/ios see Generating Signed APK