Core of the Amahi Platform, a web app in RoR
Ruby HTML CSS CoffeeScript JavaScript Makefile Python
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
app
bin
config
db
doc
lib
misc
plugins
public
script
spec
test
tmp
vendor
.gitignore
.powrc
.ruby-version
.travis.yml
COPYING
Gemfile
Gemfile.lock
Makefile
README.md
Rakefile
TODO.txt
config.ru
icla.txt

README.md

Amahi Platform

Build Status Code Climate Dependency Status Coverage Status

The Amahi Platform is a web-based app that allows management of users, shares, apps, networking and other settings in a Linux-based PC, VM or ARM-based system.

The Amahi Platform is part of Amahi and supports the services provided by Amahi.

Contributing

Contributions are always welcome! Here's what you need to do to get the Amahi platform working:

1. Clone the repo

git clone https://github.com/amahi/platform.git

2. Run the tests

You can test Amahi locally with limited functionality either on the command line or in the browser and both should work. Tests are written in CoffeeScript using QUnit.

To run on the command line, run the following command from the project root:

make run-tests

3. Write some test-driven code

The tests are in spec/. All test files are typically inside spec/requests and we use capybara and factory-girl for easy test writing.

4. Test by hand in the browser

To run the app in the browser, you need to bootstrap it first. The first db: command assumes you have MySQL up and running and will ask for the root user credentials in MySQL:

bundle install
rake db:create
rake db:migrate
rake db:seed

To start the app and use it with a browser, start a web server with rails:

rails s

Visit http://localhost:3000/, login with the username of admin & the password of admin and excersise the app as much as you can.

We like to follow a particular git branching model. You can create and work in your own branch, making your work easier to track.

5. Coding Style

Try to remove suprious white spaces and such. We have a Ruby beautifier tool that we recommend. It's a basic ruby script that will modify any number of files (in the command line) to make them more readable and keep the formatting conventions and styles that we like in Amahi.

6. Create a pull request

When you are ready for your changes and it's good code that fits with the goals of the project, submit a pull request and we will merge it!

7. Agree to CLA

For mutual protection, please check the icla.txt file for the individual contributor agreement we require for contributors. It's a virtual copy to Apache's CLA. Generally, you will be asked by email to read it and accept, otherwise it will be implied that you accept it. If you are working for a company or some large institution, we will ask that you submit a scan of the signed CLA for us to keep on file.

8. Develop Plugins

We are trying to make the platform more modular and also thinner. If you have some ideas for plugins that would improve the platform but are better done as plugins, See the plugins docs file.

License

This program is Copyright (C) 2007-2013, Amahi. Licensed under the AGPL. See the license in the COPYING file.