alakkai (அளக்கை)
=========

* A tool to create surveys, let people vote and see the results. The name alakkai is the Tamil term (அளக்கை) for survey
* For a screencast of version 1 of this software, see: <URL Should come here #TODO >
* To get alakkai working:
1) Install golang from http://golang.org
2) Install mongodb from http://www.mongodb.org/downloads
3) From your terminal: git clone git://github.com/psankar/alakkai.git
4) Edit alakkai.go and change the various CONFIG_* variables to suit your need.
5) go build alakkai.go ;#Ensure that everything builds fine
6) mongod ;#Starting mongodb server
7) ./alakkai ;#Starting alakkai server
8) In your browser, visit http://<server>:<port>/create for creating surveys. The <server> and <port> were the ones that you configured in step 4


License
=======

* All the golang and javascript source code in this project are licensed under Creative Commons Zero License http://creativecommons.org/publicdomain/zero/1.0/ 
* You are free to use these sources either fully or partially for commercial or non-commercial use.
* No guarantee or warranty is provided for this free software. No responsibility is assumed for any consequences of using this software.

* The project logo and the background image are licensed under Attribution-NonCommercial-NoDerivs 3.0 Unported 
* More information about the license is available at: http://creativecommons.org/licenses/by-nc-nd/3.0/ 
* You are strongly advised to go through the license text if you want to use any of the images.
* The project logo and the background image are copyrighted to Vaijayanthi
* You are free to use alakkai logo for your company's intranet site for free, but if you are deploying alakkai in the internet and charging users to create surveys, you have to change the logo.

* If you have any more doubts, feel free to mail the author at: sankar.curiosity@gmail.com


Programming
=============

* The program is written using the go programming language for the server-side software development. Javascript and HTML are used for the web front end.
* mongodb is used for storing the surveys and the responses, serving as the backend.
* If you are sending any code or string translations or any type of contributions to be merged with the alakkai project, it will be released in the same Creative Commons Zero License as alakkai. Send your contributions only if you agree to freely distribute your changes as mentioned by the license. 
* You can search for TODO or FIXME to know various open issues.


Authors
========
Go and Javascript sources:
Sankar சங்கர் 


Credits
=======

* The project is dedicated to my friends Ravin and his wife Vaijayanthi, for helping out my wife and me, when we got locked out of our house accidentally.
* Thanks to Ciaran Farrell for explaining me patiently, the various legal aspects and help me choose the licenses. 
* Thanks to Aravindan K for suggesting the name 'alakkai' and inspiring people to maintain language purity.