Skip to content
This repository has been archived by the owner on Jan 9, 2023. It is now read-only.

Commit

Permalink
Update README.md for typos and added links (#1055)
Browse files Browse the repository at this point in the history
* Update README.md for typos and added links

Update README.md for typos and added links for PouchDB, Docker.

* Update Readme.md

Updated Readme.md to standardize names: CouchDB, Git, Node.js, Ember.js, EmberCLI.
  • Loading branch information
lisaychuang authored and jkleinsc committed Apr 17, 2017
1 parent 6d0b1d8 commit 8761cb7
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,8 +74,8 @@ To start the frontend please do the following:
## Running with Docker

### Running With Docker Engine
To run HospitalRun with Docker please do the following:
- Goto [https://docs.docker.com/engine/installation](https://docs.docker.com/engine/installation) to download and install Docker.
To run HospitalRun with [Docker](https://www.docker.com/) please do the following:
- Go to [https://docs.docker.com/engine/installation](https://docs.docker.com/engine/installation) to download and install Docker.
- Clone the repository with the command `git clone https://github.com/HospitalRun/hospitalrun-frontend.git`.
- Change to the hospitalrun-frontend directory `cd hospitalrun-frontend`.
- Build the HospitalRun image with `docker build -t hospitalrun-frontend .`
Expand All @@ -93,7 +93,7 @@ If you are running with Docker Toolbox you will have to run the following comman
- Go to `http://<docker-machine ip>:4200` in a browser and login with username `hradmin` and password `test`.

### Accessing HospitalRun with Docker or Docker-compose
If you are not running with docker toolbox please do the following:
If you are not running with Docker toolbox, please do the following:
- Go to `http://localhost:4200` in a browser and login with username `hradmin` and password `test`.

### Troubleshooting your local environment
Expand All @@ -105,7 +105,7 @@ Otherwise, here are some tips for common issues:

**The browser shows only a loading dialog**

Is your server (still) running? Is Couch running? If not, that's probably the issue.
Is your server (still) running? Is CouchDB running? If not, that's probably the issue.

**My changes aren't showing up in the browser**

Expand All @@ -124,7 +124,7 @@ Next, click on ***Load File***. When the database load is complete a message wi

### Fixtures for Acceptance Tests

Fixtures are PouchDB dumps that are generated with [pouchdb-dump-cli](https://github.com/nolanlawson/pouchdb-dump-cli).
Fixtures are [PouchDB](https://pouchdb.com/) dumps that are generated with [pouchdb-dump-cli](https://github.com/nolanlawson/pouchdb-dump-cli).

To create a fixture, run `pouchdb-dump http://localhost:5984/main -u hradmin -p test | cat > tests/fixtures/${name_of_fixture}.txt`.

Expand Down Expand Up @@ -161,17 +161,17 @@ To start coding and understand the frameworks, concepts and structure of the pro

## Further Reading / Useful Links

* [ember.js](http://emberjs.com/)
* [ember-cli](http://www.ember-cli.com/)
* [Ember.js](http://emberjs.com/)
* [Ember CLI](http://www.ember-cli.com/)
* Development Browser Extensions
* [ember inspector for chrome](https://chrome.google.com/webstore/detail/ember-inspector/bmdblncegkenkacieihfhpjfppoconhi)
* [ember inspector for firefox](https://addons.mozilla.org/en-US/firefox/addon/ember-inspector/)
* [Ember inspector for chrome](https://chrome.google.com/webstore/detail/ember-inspector/bmdblncegkenkacieihfhpjfppoconhi)
* [Ember inspector for firefox](https://addons.mozilla.org/en-US/firefox/addon/ember-inspector/)

## Experimental

### Make
If you are willing to try using `make`, ensure you have installed git, node and couchdb (steps 1, 2 and 7 above), you may skip the rest. This requires couchdb in the path to work correctly.
* Run `make serve`, it will start couchdb, install npm dependencies and start the server.
If you are willing to try using `make`, ensure you have installed Git, Node.js and CouchDB (steps 1, 2 and 7 above), you may skip the rest. This requires CouchDB in the path to work correctly.
* Run `make serve`, it will start CouchDB, install npm dependencies and start the server.
* Run `make all` to run all tests and build the app.
* Look into `Makefile` to figure other targets available.

Expand Down

0 comments on commit 8761cb7

Please # to comment.