README.md

#rcarweb

Presentation

Take a ride in a RC car with Arduino, WebSockets and node.js.

This is a hobby project yet in its first steps. It is not functional yet.

A simple RC car which its remote control connected to a Arduino which will send instructions received from a web browser.

Install

node.js is the platform. If you don't have, install it first.

Then you need to upload the duino's C code to your board.

After, on your CLI (command-line interface) clone the project:

git clone git://github.com/henvic/rcarweb.git

And then:

cd rcarweb
npm install
npm test

This should install at least the following

npm packages

• duino
• RailwayJS
• express
• ejs
• socket.io
• less-middleware

client-side libraries

• jQuery
• Twitter Bootstrap

Run

With the Arduino connected to your computer run:

node server

Contributing (push, open bugs, etc)

Feel free to push code to this repository. Anything you want, go to the issue tracker.

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Grunt can help you with that.

It has a great watch option which watches for file changes, use it with:

grunt watch

License

This software is provided "as is", without warranty. The New BSD License and the MIT License are the licenses (case you need something legal).

Author

Henrique Vicente de Oliveira Pinto (email, Twitter, Flickr, Linkedin).