From 25865d8648576f8b21bf0f49e148e3db3643b7e7 Mon Sep 17 00:00:00 2001 From: Justkant Date: Sat, 28 Nov 2015 04:48:15 +0800 Subject: [PATCH] update readme --- README.md | 48 +++++++++++++++++++++++++++++++++++++++--------- 1 file changed, 39 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 604e63a..e91be79 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,12 @@

WhatAShop

- + Build Status - + Dependency Status - + devDependency Status @@ -14,12 +14,42 @@
-## Steps to start development: -- Install rethinkdb -- Start with ```rethinkdb --daemon``` or simply ```rethinkdb``` in a new terminal -- Then start the npm script for development with ```npm run dev``` +# Install docker toolbox +You can find a setup [here](https://www.docker.com/docker-toolbox). -## Preferred IDE: +After the installation, open the docker Quickstart Terminal. + +# Start the Production + +### With npm installed +- ```npm run compose``` + +### With docker alone +- ```docker-compose build && docker-compose up``` + +# To get the API documentation +- Clone the repository +- ```npm install``` +- ```npm run doc``` +- Open ```doc/index.html``` + +# Steps to start development + +## Start the db +### With Docker installed +- **The first time you create the db**, use ```npm run create-data``` to persist the data of the db +- ```npm run start-db &``` using a docker Quickstart Terminal + +### With RethinkDB locally +- In a standard terminal start ```rethinkdb``` + +## Start the development +- ```npm run dev``` + +## Stop the db with Docker +- ```npm run stop-db``` + +# Preferred IDE: +- Atom - WebStorm 11 - SublimeText -- Atom