1. CONTRIBUTING and README files updated

2. GPLv3 license applied 3. A couple of fixes in `sql` files made
HappyMelly · Sep 27, 2013 · 8336009 · 8336009
1 parent eb641aa
commit 8336009
Show file tree

Hide file tree

Showing 47 changed files with 1,783 additions and 4 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,37 @@
+# How to contribute
+Third-party patches are essential for keeping HM Teller great. We grow HM Teller
+and [Happy Melly](http://happymelly.com) together and simply cannot make many
+cool features due to obvious limitations of time and business demand. We want
+to keep it as easy as possible to contribute changes that add new features or
+behaviour essential for your business. There are a few guidelines that we need
+contributors to follow so that we can have a chance of keeping on top of things.
+
+## Quick guide
+Four simple steps to add changes:
+
+1. Fork the repo.
+
+2. Add a test for your change. _We know we have no tests right now. We'll fix
+this soon._
+
+3. Make the test pass.
+
+4. Push to your fork and submit a pull request.
+
+At this point you're waiting on us. We like to at least comment on. We may
+suggest some changes or improvements or alternatives.
+
+## Making changes
+
+* Please avoid working directly on `master` branch. We do not use release branches
+and keep `master` in a ready-to-deploy state
+* Check for unnecessary whitespace with `git diff --check` before committing
+* Include tests that fail without your code, and pass with it
+* Update the documentation, the surrounding one, examples elsewhere, guides,
+  whatever is affected by your contribution
+
+# Additional Resources
+
+* [Google mailing list for HM Teller contributors](https://groups.google.com/d/forum/happymelly-teller)
+* [General GitHub documentation](http://help.github.com/)
+* [GitHub pull request documentation](http://help.github.com/send-pull-requests/)
diff --git a/LICENSE b/LICENSE
diff --git a/README.md b/README.md
@@ -1,2 +1,48 @@
-# Happy Melly collaboration platform
+# Happy Melly Teller
+**Happy Melly Teller** is a web system which supports [Happy Melly](http://happymelly.com)'s
+ecosystem and perfectly suits for any business or non-profit organization
+with similar network structure.
+
+The platform allows to manage information about people, organizations, brands,
+licensees and so on. It also provides REST API for retrieving these objects
+from third-party apps and websites.
+
+## How to install and run
+### Pre-requisites
+
+1. Install Java JDK 1.7
+2. Download and install Play framework
+    * [http://www.playframework.com/download](http://www.playframework.com/download)
+    * [http://www.playframework.com/documentation/2.1.2/Installing](http://www.playframework.com/documentation/2.1.2/Installing)
+3. Download/install and start MySQL
+4. Create the database and user:
+    * `create database happymelly;`
+    * `grant all on happymelly.* TO 'melly'@'localhost' identified by 'shum' with grant option;`
+5. Create and setup Twitter application
+    * Create a new application on [https://dev.twitter.com](https://dev.twitter.com)
+    * Add callback URL `http://127.0.0.1:9000/authenticate/twitter`
+    * Set checkbox **Allow this application to be used to Sign in with Twitter**
+
+### Application
+
+1. Clone the repo
+2. Run the application
+    * `cd teller`
+    * `TWITTER_KEY=[your app consumer key] TWITTER_SECRET=[your app consumer secret] play run`
+3. Update database (it's required to give you an access by your twitter account)
+    * `update PERSON set TWITTER_HANDLE="[your twitter id]" where TWITTER_HANDLE="happy_melly";`
+    * `insert into USER_ACCOUNT (PERSON_ID, TWITTER_HANDLE, ROLE) select ID, TWITTER_HANDLE, 'admin' from PERSON where lower(TWITTER_HANDLE) = '[your twitter id]';`
+4. Open the application in a web browser
+    * open [http://localhost:9000](http://localhost:9000)
+
+## I have an idea/I want report a bug
+Please, [open an issue](https://github.com/HappyMelly/teller/issues), provide as
+much related information as possible and stay tuned :).
+
+## I want to help
+Check [notes for contributors](https://github.com/HappyMelly/teller/blog/master/CONTRIBUTING.md)
+and [documentation for developers](https://github.com/HappyMelly/teller/blog/master/DEVELOPING.md)
+
+## License
+Happy Melly Teller is licensed under [GNU General Public License v.3](http://www.gnu.org/copyleft/gpl.html)
 
diff --git a/app/Global.scala b/app/Global.scala
@@ -1,3 +1,27 @@
+/*
+ * Happy Melly Teller
+ * Copyright (C) 2013, Happy Melly http://www.happymelly.com
+ *
+ * This file is part of the Happy Melly Teller.
+ *
+ * Happy Melly Teller is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * Happy Melly Teller is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with Happy Melly Teller.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * If you have questions concerning this license or the applicable additional terms, you may contact
+ * by email Sergey Kotlov, sergey.kotlov@happymelly.com or
+ * in writing Happy Melly One, Handelsplein 37, Rotterdam, The Netherlands, 3071 PR
+ */
+
 import play.api._
 import play.api.mvc._
 import play.filters.csrf._

diff --git a/app/assets/details.js b/app/assets/details.js
@@ -1,3 +1,27 @@
+/*
+ * Happy Melly Teller
+ * Copyright (C) 2013, Happy Melly http://www.happymelly.com
+ *
+ * This file is part of the Happy Melly Teller.
+ *
+ * Happy Melly Teller is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * Happy Melly Teller is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with Happy Melly Teller.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * If you have questions concerning this license or the applicable additional terms, you may contact
+ * by email Sergey Kotlov, sergey.kotlov@happymelly.com or
+ * in writing Happy Melly One, Handelsplein 37, Rotterdam, The Netherlands, 3071 PR
+ */
+
 $(document).ready( function() {
 
     // Delete links.

diff --git a/app/assets/index.js b/app/assets/index.js
@@ -1,3 +1,27 @@
+/*
+ * Happy Melly Teller
+ * Copyright (C) 2013, Happy Melly http://www.happymelly.com
+ *
+ * This file is part of the Happy Melly Teller.
+ *
+ * Happy Melly Teller is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * Happy Melly Teller is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with Happy Melly Teller.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * If you have questions concerning this license or the applicable additional terms, you may contact
+ * by email Sergey Kotlov, sergey.kotlov@happymelly.com or
+ * in writing Happy Melly One, Handelsplein 37, Rotterdam, The Netherlands, 3071 PR
+ */
+
 $(document).ready( function() {
     $.extend( $.fn.dataTableExt.oStdClasses, {
         "sWrapper": "dataTables_wrapper form-inline"

diff --git a/app/controllers/ApiAuthentication.scala b/app/controllers/ApiAuthentication.scala
@@ -1,3 +1,27 @@
+/*
+ * Happy Melly Teller
+ * Copyright (C) 2013, Happy Melly http://www.happymelly.com
+ *
+ * This file is part of the Happy Melly Teller.
+ *
+ * Happy Melly Teller is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * Happy Melly Teller is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with Happy Melly Teller.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * If you have questions concerning this license or the applicable additional terms, you may contact
+ * by email Sergey Kotlov, sergey.kotlov@happymelly.com or
+ * in writing Happy Melly One, Handelsplein 37, Rotterdam, The Netherlands, 3071 PR
+ */
+
 package controllers
 
 import play.api.mvc._

diff --git a/app/controllers/AuthorisationHandler.scala b/app/controllers/AuthorisationHandler.scala
@@ -1,3 +1,27 @@
+/*
+ * Happy Melly Teller
+ * Copyright (C) 2013, Happy Melly http://www.happymelly.com
+ *
+ * This file is part of the Happy Melly Teller.
+ *
+ * Happy Melly Teller is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * Happy Melly Teller is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with Happy Melly Teller.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * If you have questions concerning this license or the applicable additional terms, you may contact
+ * by email Sergey Kotlov, sergey.kotlov@happymelly.com or
+ * in writing Happy Melly One, Handelsplein 37, Rotterdam, The Netherlands, 3071 PR
+ */
+
 package controllers
 
 import be.objectify.deadbolt.scala.{ DynamicResourceHandler, DeadboltHandler }

diff --git a/app/controllers/Brands.scala b/app/controllers/Brands.scala
@@ -1,3 +1,27 @@
+/*
+ * Happy Melly Teller
+ * Copyright (C) 2013, Happy Melly http://www.happymelly.com
+ *
+ * This file is part of the Happy Melly Teller.
+ *
+ * Happy Melly Teller is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * Happy Melly Teller is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with Happy Melly Teller.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * If you have questions concerning this license or the applicable additional terms, you may contact
+ * by email Sergey Kotlov, sergey.kotlov@happymelly.com or
+ * in writing Happy Melly One, Handelsplein 37, Rotterdam, The Netherlands, 3071 PR
+ */
+
 package controllers
 
 import models.{ BrandView, Activity, Brand }

diff --git a/app/controllers/Dashboard.scala b/app/controllers/Dashboard.scala
@@ -1,3 +1,27 @@
+/*
+ * Happy Melly Teller
+ * Copyright (C) 2013, Happy Melly http://www.happymelly.com
+ *
+ * This file is part of the Happy Melly Teller.
+ *
+ * Happy Melly Teller is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * Happy Melly Teller is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with Happy Melly Teller.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * If you have questions concerning this license or the applicable additional terms, you may contact
+ * by email Sergey Kotlov, sergey.kotlov@happymelly.com or
+ * in writing Happy Melly One, Handelsplein 37, Rotterdam, The Netherlands, 3071 PR
+ */
+
 package controllers
 
 import play.api.mvc._

diff --git a/app/controllers/Licenses.scala b/app/controllers/Licenses.scala
@@ -1,3 +1,27 @@
+/*
+ * Happy Melly Teller
+ * Copyright (C) 2013, Happy Melly http://www.happymelly.com
+ *
+ * This file is part of the Happy Melly Teller.
+ *
+ * Happy Melly Teller is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * Happy Melly Teller is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with Happy Melly Teller.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * If you have questions concerning this license or the applicable additional terms, you may contact
+ * by email Sergey Kotlov, sergey.kotlov@happymelly.com or
+ * in writing Happy Melly One, Handelsplein 37, Rotterdam, The Netherlands, 3071 PR
+ */
+
 package controllers
 
 import models._

diff --git a/app/controllers/LicensesApi.scala b/app/controllers/LicensesApi.scala
@@ -1,3 +1,27 @@
+/*
+ * Happy Melly Teller
+ * Copyright (C) 2013, Happy Melly http://www.happymelly.com
+ *
+ * This file is part of the Happy Melly Teller.
+ *
+ * Happy Melly Teller is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * Happy Melly Teller is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with Happy Melly Teller.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * If you have questions concerning this license or the applicable additional terms, you may contact
+ * by email Sergey Kotlov, sergey.kotlov@happymelly.com or
+ * in writing Happy Melly One, Handelsplein 37, Rotterdam, The Netherlands, 3071 PR
+ */
+
 package controllers
 
 import org.joda.time.LocalDate

diff --git a/app/controllers/Organisations.scala b/app/controllers/Organisations.scala
@@ -1,3 +1,27 @@
+/*
+ * Happy Melly Teller
+ * Copyright (C) 2013, Happy Melly http://www.happymelly.com
+ *
+ * This file is part of the Happy Melly Teller.
+ *
+ * Happy Melly Teller is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * Happy Melly Teller is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with Happy Melly Teller.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * If you have questions concerning this license or the applicable additional terms, you may contact
+ * by email Sergey Kotlov, sergey.kotlov@happymelly.com or
+ * in writing Happy Melly One, Handelsplein 37, Rotterdam, The Netherlands, 3071 PR
+ */
+
 package controllers
 
 import models.{ Person, Activity, Organisation }

diff --git a/app/controllers/OrganisationsApi.scala b/app/controllers/OrganisationsApi.scala
@@ -1,3 +1,27 @@
+/*
+ * Happy Melly Teller
+ * Copyright (C) 2013, Happy Melly http://www.happymelly.com
+ *
+ * This file is part of the Happy Melly Teller.
+ *
+ * Happy Melly Teller is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * Happy Melly Teller is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with Happy Melly Teller.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * If you have questions concerning this license or the applicable additional terms, you may contact
+ * by email Sergey Kotlov, sergey.kotlov@happymelly.com or
+ * in writing Happy Melly One, Handelsplein 37, Rotterdam, The Netherlands, 3071 PR
+ */
+
 package controllers
 
 import play.api.mvc.Controller