mlaug / wingolfsplattform Goto Github PK

Dies ist der Quellcode der entstehenden neuen Plattform von Wingolfsbund und VAW, der sog. Wingolfsplattform. Die Plattform soll vier Hauptaufgaben erfüllen: Hilfestellung bei der Verwaltung der Mitglieder des Wingolfs, Netzwerk der Mitglieder, Austausch von Informationen und Dokumenten, Präsentation nach außen. Nähere Informationen zum Anforderungsspektrum unter http://wingolf.org/ak-internet.

Ansprechpartner: Sebastian Fiedlschuster E 06 (B-xx)

Hinweis: Die Anzeigen "Coverage" und "Code Climate" beziehen sich derzeit nur auf den wingolf-spezifischen Konkretisierungs-Teil, nicht aber auf den Großteil des Codes, der unter your_platform abgelegt ist. Ferner werden die von Natur aus unschönen Import-Skripte miteinbezogen. Bis auch your_platform erfasst werden kann, sind diese Anzeigen daher nicht als repräsentativ zu betrachten.

Status	Beschreibung
	Wingolfsplattform Version
	Build Status on production
	Build Status on master
	Test Coverage on master
	Code Climate (4=good, 1=bad)
	Gemnasium Gem Dependency Monitor

Die laufende Seite ist erreichbar unter http://wingolfsplattform.org.

Continuous Deployment: Der production-Branch wird nach einem Push automatisch auf wingolfsplattform.org bereitgestellt. Den aktuell bereitgestellten Commit kann man hier abfragen: http://wingolfsplattform.org:4567

Als Server-Side-Framework verwenden wir Ruby on Rails 3.2 mit Ruby 2.0 und als Client-Side-JS-Framework AngularJS. Wir empfehlen die Verwendung von rbenv.

GETTING STARTED -- von der Installation der Entwicklungsumgebung bis zum Durchführen der automatisierten Tests.

Für kleinere Korrekturen bitte einfach unkompliziert einen Pull-Request eintragen. Bei Interesse an einer längerfristigen Mitarbeit wendet euch bitte an den Arbeitskreis Internet: ak-internet at do not spam me wingolf dot org.

cd ~/rails
git clone [email protected]:fiedl/wingolfsplattform.git
cd ~/rails/wingolfsplattform
bundle install
bundle exec rake db:create db:migrate
bundle exec rake bootstrap:all
bundle exec rake db:test:prepare
bundle exec rake

Der abstrakte Teil des Quellcodes, d.h. derjenige Teil, der auch von anderen Organisationen als dem Wingolf verwendet werden kann, ist in der your_platform-Engine unterzubringen. Die Konkretisierung und Anpassung auf die wingolfitischen Bedürfnisse erfolgt in der Haupt-Applikation.

Dieser aufgespaltete Zustand ist noch nicht vollständig erreicht. Der aktuelle Stand ist der Migrations-Matrix zu entnehmen.

• Code-Dokumentation auf rubydoc.info
• Lokal kann die Dokumentation mit dem Kommando yardoc erzeugt werden.

• Alle Entwickler möchten sich bitte mit den Rails Security Guide vertraut machen.

• Regelmäßig sollte brakeman ausgeführt werden, um nach gängigen Sicherheitslücken zu suchen.

  gem update brakeman
  cdw
  brakeman -o ~/Desktop/brakeman.html
  cdy
  brakeman -o ~/Desktop/your_platform.brakeman.html
  

• brakeman ist außerdem in unsere guard-Konfiguration eingebunden, sodass die guard-Ausgabe auch Brakeman-Sicherheitsmeldungen enthält.

• Trello Board "AK Internet: Entwicklung"
• http://wingolf.org/ak-internet

Copyright (c) 2012-2013, Sebastian Fiedlschuster

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

Der Quellcode ist unter den Lizenzbestimmungen der GNU Affero General Public License (AGPL) veröffentlicht. Hiervon sind explizit ausgenommen die Grafiken und Schriftarten in den Verzeichnissen app/assets/images und app/assets/fonts, die lediglich dem Betrieb der laufenden Primärinstanz dienen.

The Source Code is released under the GNU Affero General Public License (AGPL). Explicitely excluded are the images and fonts in the directories app/assets/images and app/assets/fonts, which are only to be used by Wingolf for production.

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