Skip to content

Commit

Permalink
Added some instructions how to start the server
Browse files Browse the repository at this point in the history
  • Loading branch information
Tommi Laukkanen authored and klaakso committed Oct 30, 2016
1 parent b1d5390 commit 544a4d8
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,29 @@
[![Coverage Status](https://coveralls.io/repos/github/BerryUniverse/berrypod-server/badge.svg?branch=master)](https://coveralls.io/github/BerryUniverse/berrypod-server?branch=master)
[![NSP Status](https://nodesecurity.io/orgs/berryuniverse/projects/d29e924f-5c84-4c95-9b66-4ee1cfc16908/badge)](https://nodesecurity.io/orgs/berryuniverse/projects/d29e924f-5c84-4c95-9b66-4ee1cfc16908)
# BerryPod Server Backend / REST API

## Dependencies

* [Node.js](https://nodejs.org)
* [MongoDB](https://www.mongodb.com/) - Data storage

## Simple usage

Make sure you have MongoDB instance up and running first. Modify the *config.js* file to point to your database instance and change your host port if needed.

Install dependencies:

```
npm install
```
Start the server e.g. with:

```
npm start
```
..or..

```
npm run watch
```
..to start server with _nodemon_ for easier development.

0 comments on commit 544a4d8

Please sign in to comment.