YourPlatform

Join the chat at https://gitter.im/fiedl/your_platform Gem Version Build Status Code Climate Dependency Status

YourPlatform is a ruby on rails engine that provides the basis for administrtive and social network platforms for closed user groups such as alumni organizations.

The application serves four main purposes: Centralized or decentralized member management, networking features for members, exchange of information and documents and communication.

Getting Started Developing

  1. Have a look at our demo application: We are currently moving to another server. After that, the demo link will be provided here.
  2. Check out the demo application locally:

    git clone git@github.com:fiedl/your_platform.git
    cd your_platform/demo_app/my_platform
    
    # provide a config/database.yml according to your local mysql credentials
    
    bundle install
    bundle exec rake db:create db:migrate
    bundle exec foreman start
    bundle exec rails server
    

    View the application at http://localhost:3000.

  3. If you want to create an application based on the YourPlatform engine, please follow the GETTING STARTED GUIDE in the wiki.

If you have any troubles, feel free to contact us on our gitter channel.

Documentation

Our code documentation can be found on rubydoc.info.

Versioning

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

Authors and License

Copyright (c) 2012-2015, Sebastian Fiedlschuster

Contributors: Jörg Reichardt, Manuel Zerpies, Joachim Back

License: The Source Code is released under the GNU Affero General Public License (AGPL). Explicitely excluded are the images and fonts.

This program 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 Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see http://www.gnu.org/licenses/.