From 2e2617e5de348326d1ecef32056fcf47d6de0868 Mon Sep 17 00:00:00 2001 From: Thomas FORGIONE Date: Tue, 19 May 2015 18:03:35 +0200 Subject: [PATCH] Update readme --- README.md | 22 +++++++++++++++++++--- 1 file changed, 19 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index c886469..b8cba4d 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,26 @@ # 3D Interface -A prototype for a user-friendly 3D interface allowing to browse 3D scenes / models written with Node.js. +A prototype for a user-friendly 3D interface allowing to browse 3D scenes / +models written with Node.js. -It is hosted by [OpenShift](https://www.openshift.com/) at [3dinterface.no-ip.org](http://3dinterface.no-ip.org). +It is hosted by [OpenShift](https://www.openshift.com/) at +[3dinterface.no-ip.org](http://3dinterface.no-ip.org). ## To run a local server -As usual with NodeJS, it's quite easy to test. Just ensure you have `node` installed on your machine, clone this repo somewhere, and then, in the repo do +First you need to configure the database. You can create a postgres database +where you want, and you can initialize it by running the script +`sql/backup.pgsql`. + +Then, you have to set up nodejs to access to your database. Basically, you have +to create a file `private.js` at the root of the repository looking like this : + +``` javascript +module.exports.url = ... // the url to connect to your database + +module.exports.secret = ... // A secret string used to hash stuff +``` + +As usual with NodeJS, it's quite easy to test. Just ensure you have `node` +installed on your machine, clone this repo somewhere, and then, in the repo do ``` sh npm install