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

README improved

This commit is contained in:
Thomas FORGIONE 2016-01-04 17:56:25 +01:00
parent 0808d00bcb
commit 1bee439d5a
1 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -12,13 +12,15 @@ where you want, and you can initialize it by running the script
## 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 :
to create a file `private.js` in the `server` directory 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
```
## Compiling the static js files
First, `cd` to `utils/`. Here you'll find a script `build_all.sh` that, as its
name suggests, builds all. By default, it minifies the code, but you can pass
@ -32,10 +34,14 @@ 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
cd server
npm install
node server.js
```
*Note : you will need to compile the static js files first in order to start
the server*
You should be able to go to [localhost:4000](http://localhost:4000) and see the
result.