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

Update README.md for typos and added links #1055

Merged
merged 2 commits into from
Apr 17, 2017
+11 −11
Merged

Update README.md for typos and added links #1055

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
846be7c
Update README.md for typos and added links
lisaychuang Apr 12, 2017
d4df444
Update Readme.md
lisaychuang Apr 13, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
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 Down Expand Up @@ -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 @@ -170,7 +170,7 @@ To start coding and understand the frameworks, concepts and structure of the pro
## 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.
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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In order to be consistent with the rest of the doc, CouchDB should be referred to as CouchDB not Couchdb. Also, since you are changing the text here, can you change git to Git and node to Node.js for consistency as well?

* 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