Administrative and social network platform for closed user groups.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
app
config
core_ext
db/migrate
demo_app/my_platform
docker/services/your_platform_web_development
lib
screenshots
script
spec
test/mailers/previews
vendor
.coveralls.yml
.gitattributes
.gitignore
.rspec
.ruby-version
.travis.yml
.yardopts
AGPL.txt
Gemfile
Gemfile.lock
Guardfile
LICENSE.md
README.md
Rakefile
bin
docker-compose.yml
package.json
yarn.lock
your_platform.gemspec

README.md

YourPlatform

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

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.

screenshot

Getting Started Developing

Install Docker including docker-compose on your development machine.

Then check out and start the standalone application:

git clone git@github.com:fiedl/your_platform.git
cd your_platform

docker-compose up

Open http://localhost:3001 in your web browser.

Attention: Do not use this in production on a real server as docker-compose.yml includes dummy passwords!

Make sure that your docker machine has at least 8GB of RAM.

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.

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-2019, 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/.

Senior clause for VAW e.V.: For commit 1b459b92e and later, Philistres of the VAW e.V. may only use the software if the development work is compensated in accordance with the so-called "new development model".