Skip to content

Commit 33f0637

Browse files
Create README.md
1 parent 728c373 commit 33f0637

1 file changed

Lines changed: 15 additions & 0 deletions

File tree

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# TeamTreeHouseProject11 [![Build Status](https://travis-ci.org/Threatsignal/TeamTreeHouseProject11.svg?branch=master)](https://travis-ci.org/Threatsignal/TeamTreeHouseProject11)
2+
3+
A Project creating a REST API using express. The API will provide a way for users to review educational courses: users can see a list of courses in a database; add courses to the database; and add reviews for a specific course.
4+
5+
## Prerequisites
6+
This project requires mongoDb installed and configured on the server. For more information please visit one of the following:
7+
- For [Windows](http://treehouse.github.io/installation-guides/windows/mongo-windows.html)
8+
- For [Mac](http://treehouse.github.io/installation-guides/mac/mongo-mac.html)
9+
10+
## Installation
11+
- Clone the project into a folder using git or download off github.
12+
- At root of project where package.json is Run: `npm install`
13+
- Once finished installing dependencies Run: `npm start`
14+
- To run tests on project Run: `npm test`
15+
- To get coverage report on project Run: `npm run coverage`

0 commit comments

Comments
 (0)