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

Update README.md

This commit is contained in:
Thomas FORGIONE 2015-05-22 18:05:24 +02:00
parent 359b810848
commit d3dba4a572
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -6,10 +6,12 @@ It is hosted by [OpenShift](https://www.openshift.com/) at
[3dinterface.no-ip.org](http://3dinterface.no-ip.org).
## To run a local server
### Database setup
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`.
### Nodejs configuration
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 :
@ -18,7 +20,17 @@ module.exports.url = ... // the url to connect to your database
module.exports.secret = ... // A secret string used to hash stuff
```
### Compiling the static js files
Once this is done, you have to generate the static javascript files. To do this,
you should go to the directory `js` at the root and run `make`. You will need to
have[closure-compiler](https://github.com/google/closure-compiler) on your machine.
If it doesn't work, check in the `Makefile` that the path to `closure-compiler.jar`
is correct.
This will generate lots of `*.min.js` in `static/js`.
### Running 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