about this project
this project contains a set of examples and tests for the RESTful API for the sTeam server.
the code is written in coffeescript and needs node.js only for coffeescript translation.
the back-end is a RESTful API written for the sTeam server as used by techgrind.asia
step 1: install node.js
step 2: clone the repo
git clone https://github.com/societyserver/steam-rest
step 3: install node packages:
this installs all dependencies (including coffee) for our project into the project's node_modules directory based on the 'package.json' file
step 4: start the server
but for convenience we can install coffee in the global node environment:
npm install -g coffee-script
so we can just say
if the server is working you'll see:
Listening on port 8000
how to contribute your changes
fork the project on github
clone the forked project to your computer
git clone https://github.com/<your name>/steam-rest
follow the instructions above to set up your environment
when you are properly set up you should be able to load http://localhost:8000/ in your browser
each example should be a standalone application, so copy one example, and modify it.
push changes to your repo frequently.
when ready please file a merge request or notify the project developers about your contribution
Once you have nodejs installed, run the following statement to install Frisby and Jasmine:
npm install -g jasmine-node frisby
Then execute the test by:
cd project/directory jasmine-node tests/