Skip to content

Latest commit

 

History

History
109 lines (86 loc) · 5.42 KB

README.md

File metadata and controls

109 lines (86 loc) · 5.42 KB
Raw

Front-End Checklist Logo

People Making A Difference - JumboCode Fall 2017

Build Status License Open Source Love Contributors

App Description:

This app facilitates the check-in and check-out process for volunteers and notifies them about their roles and where they should be during their shifts. Hence, it has a back end that processes the data, front end desktop for the administrator to edit the information, and the front end mobile that displays the most up-to-date information to the volunteers.

Group Members:

Meeting minutes and attendance

Workboard

  1. Project Lead: John Gallagher
  2. Mobile Lead: Joseph Higgins
  3. UX/Design/Developer: Anna Kasagawa
  4. UX/Design/Secretary/Developer: Lexi Walker
  5. Developer: Meet Patel
  6. Developer: Phoebe Yang
  7. Continuous Integration/Developer: Kate Zheng
  8. Developer: Julia Hedrick
  9. Developer: Michael Dunkelman
  10. Documentation/Developer: Josh Lee
  11. Developer: Bhushan Suwal
  12. Developer: Kevin Bae
  13. Developer: Andrea Vorametsanti

Overview of the Project

The project consists of three major parts: the backend (which utilizes the database), the desktop frontend, and the mobile frontend. The backend is built on Node.js and Express, with the MongoDB database service running. The frontend desktop is built on Angular. The frontend mobile is built on Ionic.

Instruction Guideline

List of installation guidelines and instructions to run the different parts of the PMD project.

Install Guidelines

Before you do anything else:

  • Install node, which comes with node package manager. Npm is important for installing both pieces of the frontend and the backend.

Database

To Install:

  • Requirements: none, can be installed from within any directory
  • Commands: download here, Google the commands to set the right acess for your OS (it varies)

To Run MongoDB:

  • Requirements: none, can be run from within any directory
  • Command: mongod

To Create Database:

  • Requirements: MongoDB must be running (see above)
  • Command: mongo pmd (where “pmd” is the name of the database to be created)

To Seed the Local Database:

  • Requirements: MongoDB must be running (see above), database named “pmd” must exist
  • Command: node app.js (runs the file “app.js”)

Dropping the Database:

  • If anything is wrong with the database (ex. it's been seeded multiple times), then you should drop the database
  • Requirements: on PMD database (command: use pmd)
  • Command: db.dropDatabase()

Back End

To Install:

  • Requirements: within directory '/backend', npm installed
  • Command: npm install

To Run:

  • Requirements: Back end install complete, currently within directory '/backend', MongoDB running
  • Requirements: A node api key json file for the firebase admin SDK. Create one here.
  • Command: node index.js
    • If running properly, should display “Node app is running on port 500”

Desktop Front End

To Install Package:

  • Requirements: none, can be within any directory, npm installed
  • Command: npm install @angular/cli, or download manually through this link

To Install Dependencies:

  • Requirements: Within directory '/DesktopFrontend', npm installed
  • Command: npm install

To Run:

  • Requirements: Within directory '/DesktopFrontend', above install complete
  • Command: ng serve
    • To View: localhost:4200 in browser

Mobile Front End

To Install Package:

  • Requirements: none, can be within any directory, npm installed
  • Command: npm install ionic

To Install Dependencies:

  • Requirements: Within directory '/MobileFrontend', npm installed
  • Command: npm install

To Run:

  • Requirements: Within directory '/MobileFrontend', above install complete
  • Command: ionic serve
    • To View: localhost:8100 in browser