Happy Melly Teller

Happy Melly Teller is a web system which supports Happy Melly'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 2.2.2

   • http://www.playframework.com/download
   • http://www.playframework.com/documentation/2.2.2/Installing

3. Download/install and start MySQL 5.6

4. Create the database and user:

    create database happymelly;
    grant all on happymelly.* TO 'melly'@'localhost' identified by 'shum' with grant option;
    use happymelly;
   

5. Create and setup Twitter application

   • Create a new application on 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

6. Set up Memcache (you can use any Memcache service like Memcachier

Application

1. Clone the repo

2. Run the application, specifying configuration properties on the command line or as environment variables. You can use any value for AWS keys if you don’t need booking entry attachments to work. You can also provide dummy values for authentication service keys that you don’t need to use.

    cd teller
    export AWS_ACCESS_KEY_ID=[Amazon web services key]
    export AWS_SECRET_KEY=false TWITTER_KEY=[your app consumer key]
    export TWITTER_SECRET=[Twitter app consumer secret]
    export FACEBOOK_ID=[App ID]
    export FACEBOOK_SECRET=[App secret]
    export GOOGLE_ID=[App ID]
    export GOOGLE_SECRET=[App secret]
    export LINKEDIN_KEY=[App key]
    export LINKEDIN_SECRET=[App secret]
    export GOOGLE_ID=[App ID]
    export GOOGLE_SECRET=[App secret]
    export MEMCACHIER_SERVERS=[url]
    export MEMCACHIER_USERNAME=[username]
    export MEMCACHIER_PASSWORD=[password]
    play run
   

3. Open the application in a web browser and run Evolutions to populate the database

   • open http://localhost:9000
   • on the Database 'default' needs evolution! page, click Apply this script now!

4. Update database (required to give you access by your Twitter account). Alternatively, add a Facebook profile URL, a Google+ profile URL or a LinkedIn public profile URL, in the appropriate table columns.

    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]';
   

5. Time to log in, pal!

I have an idea/I want report a bug

Please, open an issue, provide as much related information as possible and stay tuned :).

I want to help

Check notes for contributors

License

Happy Melly Teller is licensed under GNU General Public License v.3. It includes iText library which is licensed under AGPL.