/Mercury

Primary LanguageJavaScript

Mercury

Mercury is a MLH Externship Fellowship project by the Electric Eagles group from Pod 2-2-1.

About

This purpose of this project is to build a communication platform that eases the common paperwork burden for the reserve units in the US Army. Soldiers in such units often have to fill out tedious paperwork to request permission for absence from weekend drills. COVID-19 also brings about additional paperwork. Unfortunately, all such paperwork would need to be printed, then scanned & uploaded, by soldiers, only to be printed-scanned-signed again by their commanders. Mercury aims to streamline this process by digitizing these steps.

The name Merucy was inspired by Mercurius who, in Roman religion, was the god of communication.

The project uses React Native which is helpful in developing a single application that deploys to both Android and iOS devices. The chat feature is built using the GiftedChat library.

Features

  • Users can login/sign-up (authentication)
  • Users see a scrollable list of upcoming events
  • Users can have access to features & information depending on their rank-based account privileges (authorization)
  • Users can see a COVID screening form
  • Users can view & edit their profiles
  • Users can direct message (1-on-1 chat)
  • Users can message a group (group chat)

Wiki Documentation

The project Wiki Documentation can be found here.

Tools we used

  • React Native
  • Firebase
  • React Navigation
  • Expo
  • Axios
  • Forimk
  • Yup
  • Additional libraries used are listed in our package.json

Setup + API

Step 1

Clone this repository

Step 2

Install the packages for this application

npm install

Step 3

Running the application

npm start

Step 4

For API usage, click here

License

Copyright 2021 Eletric Eagles, Pod 2-2-1, MLH Externship Fellowship

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Authors

Jun Qi Li

Eric Widjaja