tforgione
/
3d-interface
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update readme

This commit is contained in:
Thomas FORGIONE 2015-05-19 18:03:35 +02:00
parent dced15724a
commit 2e2617e5de
1 changed files with 19 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -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