Amahi Edge

From Amahi Wiki
Jump to: navigation, search

Amahi Edge is the developer version of Amahi, with the very latest and greatest code in it. It lives in a branch of the Amahi Git repo, called

  amahi-edge

This page is about working notes for the latest in the development tree.

How to Get Amahi Edge Running (Amahi 7)

This assumes you have clean Fedora 17 install (without updates):

  1. open a terminal window
  2. as Root (su):
    1. enter the root password (not the one from the first user)
    2. yum groupinstall 'Development Tools'
    3. yum install ruby ruby-devel git libxml2-devel libxslt-devel mysql-devel sqlite-devel mysql-server
    4. systemctl start mysqld.service
  3. download the latest tarball or get the latest git repo code
  4. extract the tarball into your user folder use tar or your file manager-extract function
  5. cd ~/amahi-7
  6. gem install bundler
  7. bundle install (this will install all the necessary gems)
  8. rake db:create this will ask for the mysql root password with a prompt ">" (note that it will show a warning and echo the password!)
  9. rake db:migrate (this will get the database up to snuff)
  10. rake db:seed (this will get a basic database setup)
  11. rails s (this will start the rails server)

The development dashboard can be reached with your favorite browser at:

  http://localhost:3000

To stop the development server, just hit Ctrl+C in the terminal where you started the server.

Run Tests

A great way to contribute is to write tests. The spec tests are in the spec/ directory. To run them:

    rake spec

It will show you one dot per test passing. It will show test fails with F and display the error.

You may need to

    yum install rubygem-minitest

to get things to run properly for some reason that we did not root cause yet.

Old info for Amahi 6

First you need to get the latest git repository (see how on the Contribute-page)

After you've got the latest master branch you need to switch to the amahi-edge branch (and tell git to follow it on the remote server):

git checkout amahi-edge

The amahi-edge code uses a different database for it's data so we need to create one, copy the production data in it and migrate it to the new datamodel:

  • Go to /path/to/git/clone/platform/platform
  • Execute ./hda-create-db-and-user amahi_devel
  • Go to /path/to/git/clone/platform/platform/html/script
  • Execute ./db-duplicate hda_production amahi_devel
  • Go to /path/to/git/clone/platform/platform/html
  • Execute rake db:migrate

Now we have a working amahi-edge branch which can be used to develop features, gadgets, widgets and fix bugs.

To reach the amahi-edge branch you need to go to /path/to/git/clone/platform/platform/html and execute

./script/server

How to install one Gadget

If you have developed a new gadget or fixed some bugs on an existing one you can install it using:

  • Go to /path/to/git/clone/platform/platform/html
  • Execute rake gadgets:install source=/path/to/the/gadget/source, e.g.
         rake gadgets:install source=../../gadgets/gadget_last_modified_files

When there are errors after installing the gadget you can uninstall it using:

  • Go to /path/to/git/clone/platform/platform/html
  • Execute rake gadgets:uninstall source=/path/to/the/gadget/source

Tips

  • Start with VM with snapshots. Take a snapshot of your VM to begin, in case you have to revert
  • If you do not have a VM, take a snapshot of your development database. You can use ./script/db-duplicate and ./script/db-restore (use with care!)