aproposnix / front

Humansis - Beneficiary Management System

A platform that allows humanitarian organisations to manage relief items (Food, Non Food Items, CASH) to people in need for life-saving humanitarian responses to emergency situations.

About

Humansis is the first fully open-source relief platform for humanitarian actors to efficiently manage relief operations after a disaster, during a war or in response to long term crises.

What's here

This repo is the "master" repo for all Humansis-related projects. It hosts the documentation, the frontend and other misc. Code for other projects, like the API is hosted in other repositories.

Contributing

We welcome contributions from anyone who acts in good faith and in a respectful manner and adds value to the project.

We are looking for collaboration from the Open Source community! There's so much we want to do, including but not limited to: enhancing existing applications with new features, optimizing the technical tools and algorithms involved to accommodate humanitarian challenges, and bringing our work closer to the public to leverage their inputs via blog posts and tutorials.

• Please read our contribution guidelines for details on what and how you can contribute.
• Check out our Trello Development Project Board.
• Look for tasks labelled good first issues under the Issues tab in each repo.

Documentation

We are hoping to establish a more user-friendly version soon, one that is readable by our potential users (e.g. developers and humanitarian actors).

Resources

To understand Humansis better:

• Read the README for each repo. An architecture diagram of how these components are connected to one another is coming soon.

BMS Front tech doc

This project was generated with Angular CLI version 6.2.3.

Development server

Run ng serve -o for a dev server. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files.

Build

Run ng build --prod to build the project. The build artifacts will be stored in the dist/bms-front directory.

Deploy on AWS S3

You need to set up a s3 bucket and make sure "Static website hosting" is enabled as well as public access to read data.

A simple tutorial for reference: https://medium.com/codefactory/angular2-s3-love-deploy-to-cloud-in-6-steps-3f312647a659

To push the build code to S3 Bucket: aws s3 cp ./dist/bms-front s3://your-s3-bucket --recursive --acl public-read

A script has been created to compress and upload the project to the S3 bucket.

Running unit tests

Run ng test to execute the unit tests via Karma.

Running end-to-end tests

Run ng e2e to execute the end-to-end tests via Protractor.

Further help

To get more help on the Angular CLI use ng help or go check out the Angular CLI README.

Compatibilities

• Drag and drop doesn't work in Mozilla

Docker

This project works with Docker. Pay attention to the @angular/cli version in your package.json file and make sure it corresponds to the one in the Dockerfile.

To start coding in a safe environment, please launch the docker container with the following command:

sudo docker-compose up devapp

If it's the first time, please run

sudo ./docker-build.sh bms/front

Technical specifications

The code follows the specifications explained here.