maniacs-oss / teller

Happy Melly Teller system

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 Vagrant. Follow this guide from their official site: [https://docs.vagrantup.com/v2/installation/index.html](Installing Vagrant)

2. 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

Application

1. Clone the repo, (for the meantime pull the branch that works with vagrant) ..

2. Supply the needed values for the following:

     > cd teller/vagrant
     > vim up.bash
     ...
     # hm-teller specific variables
     aws_key=
     aws_secret=
     fb_app_id=
     fb_secret=
     google_app_id=
     google_secret=
     linkedin_key=
     linkedin_secret=
     twitter_key=
     twitter_secret=
     memcached_url=127.0.0.1:112111
     memcached_username=happymelly
     memcached_password=
     ...
   

   Save your changes then go back to the root directory (ie teller)

     > cd teller
   

3. Run the application. Start vagrant (vagrant up) then tunnel your way with ssh(vagrant ssh). From inside vagrant, you can run sbt run .

       > vagrant up
       > vagrant ssh
       #.. inside vagrant
       vagrant@hm-teller:/ > cd /vagrant
       vagrant@hm-teller:/ > sbt run
   

4. 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!

5. Update database (required to give you access by your twitter account).

  > vagrant ssh
  vagrant@hm-teller > mysql -u melly -pshum
  mysql > update user_account set TWITTER_HANDLE="[your twitter id]" where TWITTER_HANDLE="skotlov";

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.