From 164f78cf8be5f629022cdbdc39f171aad6773884 Mon Sep 17 00:00:00 2001 From: Joel Glovier Date: Mon, 27 Mar 2017 12:28:44 -0400 Subject: [PATCH 1/7] add clarification for clone vs fork --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b79764cfb3..cef2e0abce 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ To install the frontend please do the following: 3. Install [ember-cli latest](https://www.npmjs.org/package/ember-cli): `npm install -g ember-cli@latest`. Depending on your [npm permissions](https://docs.npmjs.com/getting-started/fixing-npm-permissions) you might need root access to install ember-cli. 4. Install [bower](https://www.npmjs.org/package/bower): `npm install -g bower` -5. Clone this repo with `git clone https://github.com/HospitalRun/hospitalrun-frontend`, go to the cloned folder and run `script/bootstrap`. (*Note: Depending on your [npm permissions](https://docs.npmjs.com/getting-started/fixing-npm-permissions) you might need root access to install PhantomJS2; also, Windows users must run with [Cygwin](http://cygwin.org/)*). +5. Clone this repo with `git clone https://github.com/HospitalRun/hospitalrun-frontend`, go to the cloned folder and run `script/bootstrap`. (*Note: Depending on your [npm permissions](https://docs.npmjs.com/getting-started/fixing-npm-permissions) you might need root access to install PhantomJS2; also, Windows users must run with [Cygwin](http://cygwin.org/)*). **Note:** *if you just want to use the project, cloning is the best option. However, if you wish to contribute to the project, you will need to fork the project first, and then clone your `hospitalrun-frontend` fork and make your contributions via a branch on your fork.* 6. Install and configure [CouchDB](http://couchdb.apache.org/) 1. Download and install CouchDB from http://couchdb.apache.org/#download 2. Start CouchDB From 76dda407a690349439e68ee497d0fc9ec9c6852c Mon Sep 17 00:00:00 2001 From: Joel Glovier Date: Mon, 27 Mar 2017 12:33:00 -0400 Subject: [PATCH 2/7] better formatting --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index cef2e0abce..ecde116af8 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,9 @@ To install the frontend please do the following: 3. Install [ember-cli latest](https://www.npmjs.org/package/ember-cli): `npm install -g ember-cli@latest`. Depending on your [npm permissions](https://docs.npmjs.com/getting-started/fixing-npm-permissions) you might need root access to install ember-cli. 4. Install [bower](https://www.npmjs.org/package/bower): `npm install -g bower` -5. Clone this repo with `git clone https://github.com/HospitalRun/hospitalrun-frontend`, go to the cloned folder and run `script/bootstrap`. (*Note: Depending on your [npm permissions](https://docs.npmjs.com/getting-started/fixing-npm-permissions) you might need root access to install PhantomJS2; also, Windows users must run with [Cygwin](http://cygwin.org/)*). **Note:** *if you just want to use the project, cloning is the best option. However, if you wish to contribute to the project, you will need to fork the project first, and then clone your `hospitalrun-frontend` fork and make your contributions via a branch on your fork.* +5. Clone this repo with `git clone https://github.com/HospitalRun/hospitalrun-frontend`, go to the cloned folder and run `script/bootstrap`. + - **Note:** Depending on your [npm permissions](https://docs.npmjs.com/getting-started/fixing-npm-permissions) you might need root access to install PhantomJS2; also, Windows users must run with [Cygwin](http://cygwin.org/)). + - **Note:** If you just want to use the project, cloning is the best option. However, if you wish to contribute to the project, you will need to fork the project first, and then clone your `hospitalrun-frontend` fork and make your contributions via a branch on your fork. 6. Install and configure [CouchDB](http://couchdb.apache.org/) 1. Download and install CouchDB from http://couchdb.apache.org/#download 2. Start CouchDB From 2878d63493f13cebc5929750e49afa5511d70ab0 Mon Sep 17 00:00:00 2001 From: Joel Glovier Date: Mon, 27 Mar 2017 12:34:20 -0400 Subject: [PATCH 3/7] moar formatting... --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ecde116af8..457c3b2c6b 100644 --- a/README.md +++ b/README.md @@ -23,8 +23,8 @@ To install the frontend please do the following: Depending on your [npm permissions](https://docs.npmjs.com/getting-started/fixing-npm-permissions) you might need root access to install ember-cli. 4. Install [bower](https://www.npmjs.org/package/bower): `npm install -g bower` 5. Clone this repo with `git clone https://github.com/HospitalRun/hospitalrun-frontend`, go to the cloned folder and run `script/bootstrap`. - - **Note:** Depending on your [npm permissions](https://docs.npmjs.com/getting-started/fixing-npm-permissions) you might need root access to install PhantomJS2; also, Windows users must run with [Cygwin](http://cygwin.org/)). - - **Note:** If you just want to use the project, cloning is the best option. However, if you wish to contribute to the project, you will need to fork the project first, and then clone your `hospitalrun-frontend` fork and make your contributions via a branch on your fork. + - **Note:** *Depending on your [npm permissions](https://docs.npmjs.com/getting-started/fixing-npm-permissions) you might need root access to install PhantomJS2; also, Windows users must run with [Cygwin](http://cygwin.org/)).* + - **Note:** *If you just want to use the project, cloning is the best option. However, if you wish to contribute to the project, you will need to fork the project first, and then clone your `hospitalrun-frontend` fork and make your contributions via a branch on your fork.* 6. Install and configure [CouchDB](http://couchdb.apache.org/) 1. Download and install CouchDB from http://couchdb.apache.org/#download 2. Start CouchDB From e45961d46806a30921333594efd7f8d343289930 Mon Sep 17 00:00:00 2001 From: Joel Glovier Date: Mon, 27 Mar 2017 12:40:51 -0400 Subject: [PATCH 4/7] add a TOC --- README.md | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 457c3b2c6b..12499c38e0 100644 --- a/README.md +++ b/README.md @@ -9,11 +9,25 @@ _Ember frontend for HospitalRun_ To run the development environment for this frontend you will need to have [Git](https://git-scm.com/), [Node.js](https://nodejs.org), [Ember CLI](http://ember-cli.com/), [Bower](http://bower.io/), and [CouchDB](http://couchdb.apache.org/) installed. +- [Contributing](#contributing) +- [Installation](#installation) +- [Running the appplication](#running-the-application) +- [Running with Docker](#running-with-docker) +- [Accessing HospitalRun with Docker Toolbox](#accessing-hospitalRun-with-docker-toolbox) +- [Accessing HospitalRun with Docker](#accessing-hospitalRun-with-docker) +- [Troubleshooting your local environment](#troubleshooting-your-local-environment) +- [Loading sample data](#loading-sample-data) +- [Testing](#testing) +- [Contributing](#contributing-1) +- [Start coding](#start-coding) +- [Further Reading / Useful Links](#further-reading--useful-links) +- [Experimental](#experimental) + ## Contributing Contributions are welcome via pull requests and issues. Please see our [contributing guide](https://github.com/hospitalrun/hospitalrun-frontend/blob/master/.github/CONTRIBUTING.md) for more details, including a link to join our project Slack. -## Install +## Installation To install the frontend please do the following: 1. Make sure you have installed [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) @@ -47,7 +61,7 @@ To install the frontend please do the following: 2. Or start the application from your applications folder. -## Start +## Running the appplication To start the frontend please do the following: - Start the server by running `npm start` in the repo folder. If `npm start` doesn't work for you, try `ember serve` as an alternative. From 48af93a099f0cdc3c8fc4955beee332baa344793 Mon Sep 17 00:00:00 2001 From: Joel Glovier Date: Mon, 27 Mar 2017 12:42:10 -0400 Subject: [PATCH 5/7] one p too many --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 12499c38e0..a6ac337418 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ To run the development environment for this frontend you will need to have [Git] - [Contributing](#contributing) - [Installation](#installation) -- [Running the appplication](#running-the-application) +- [Running the application](#running-the-application) - [Running with Docker](#running-with-docker) - [Accessing HospitalRun with Docker Toolbox](#accessing-hospitalRun-with-docker-toolbox) - [Accessing HospitalRun with Docker](#accessing-hospitalRun-with-docker) @@ -61,7 +61,7 @@ To install the frontend please do the following: 2. Or start the application from your applications folder. -## Running the appplication +## Running the application To start the frontend please do the following: - Start the server by running `npm start` in the repo folder. If `npm start` doesn't work for you, try `ember serve` as an alternative. From 1715aae7c16c8e33b31692942417d5eaa4cbb726 Mon Sep 17 00:00:00 2001 From: Joel Glovier Date: Mon, 27 Mar 2017 12:43:52 -0400 Subject: [PATCH 6/7] builds on one line --- README.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/README.md b/README.md index a6ac337418..9e40f7c4af 100644 --- a/README.md +++ b/README.md @@ -3,9 +3,7 @@ HospitalRun frontend _Ember frontend for HospitalRun_ -[![Build Status](https://travis-ci.org/HospitalRun/hospitalrun-frontend.svg?branch=master)](https://travis-ci.org/HospitalRun/hospitalrun-frontend) - -[![CouchDB](https://img.shields.io/badge/couchdb-2.0-green.svg)](http://couchdb.apache.org/) +[![Build Status](https://travis-ci.org/HospitalRun/hospitalrun-frontend.svg?branch=master)](https://travis-ci.org/HospitalRun/hospitalrun-frontend) [![CouchDB](https://img.shields.io/badge/couchdb-2.0-green.svg)](http://couchdb.apache.org/) To run the development environment for this frontend you will need to have [Git](https://git-scm.com/), [Node.js](https://nodejs.org), [Ember CLI](http://ember-cli.com/), [Bower](http://bower.io/), and [CouchDB](http://couchdb.apache.org/) installed. From 8db6a94bcc3f902a3bc085fc37341dc919f9bba0 Mon Sep 17 00:00:00 2001 From: Joel Glovier Date: Mon, 27 Mar 2017 12:44:47 -0400 Subject: [PATCH 7/7] a heading is helpful... --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 9e40f7c4af..ed801ebed7 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,8 @@ _Ember frontend for HospitalRun_ To run the development environment for this frontend you will need to have [Git](https://git-scm.com/), [Node.js](https://nodejs.org), [Ember CLI](http://ember-cli.com/), [Bower](http://bower.io/), and [CouchDB](http://couchdb.apache.org/) installed. +## Table of contents + - [Contributing](#contributing) - [Installation](#installation) - [Running the application](#running-the-application)