45a7d105ed | ||
---|---|---|
controllers | ||
js | ||
lib | ||
my_modules | ||
posts | ||
sql | ||
static | ||
views | ||
.gitignore | ||
README.md | ||
package.json | ||
server.js | ||
urls.js |
README.md
3D Interface
A prototype for a user-friendly 3D interface allowing to browse 3D scenes / models written with Node.js.
It is hosted by OpenShift at 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 :
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
haveclosure-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 the 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
npm install
node server.js
You should be able to go to localhost:4000 and see the result.