Skip to content

Latest commit

 

History

History
79 lines (56 loc) · 2.2 KB

Readme.md

File metadata and controls

79 lines (56 loc) · 2.2 KB

Overview

Medic Bulk Utils is a set of command line tools and documentation to help manage large amounts of Medic Mobile data.

The following command line tools are installed with this package:

Requirements

The minimal requirements to run these tools and example projects are NodeJS and GNU Make. Almost every Unix based system on the planet has a make binary preinstalled, typing make -v in your terminal should provide version information and confirms it's installed.

On OSX, GNU Make is bundled with the Xcode Command Line Tools, run xcode-select --install from the terminal and choose Install if you only want the command line tools installed and not the full Xcode package.

Getting Started

A new project typically begins with a spreadsheet of raw data that you want to update or add (import). This might be an export from a database or maintained some other way.

Create a directory for your project, name it whatever you want:

mkdir medic-projects-493 && \
cd medic-projects-493

Create your package.json (using -y to accept defaults):

npm init -y

Install this dependency:

npm install --save medic-bulk-utils

Project Templates

This repo is bundled with a set of project templates for common tasks. This is a good starting point for your projects. You can just copy and modify these files in your working directory to get started. Each project template also includes a Makefile so after installing you can execute make to run the example.

Example:

cp -i node_modules/medic-bulk-utils/project-templates/import-users/* .
make

Then read the instructions:

cat Readme