fiedl/wingolfsplattform

# Wingolfsplattform

Dies ist der Quellcode der Mitgliederplattform des Erlanger Wingolfs. Sie erfüllt fünf Hauptaufgaben: Hilfestellung bei der Verwaltung der Mitglieder, Netzwerk der Mitglieder, Austausch von Informationen und Dokumenten, Bereitstellung verlässlicher Kommunikationskanäle und Präsentation nach außen.

## Mitarbeit

Die Wingolfsplattform ist ein Produkt vieler ehrenamtlicher Mitwirkender. Wenn Du Interesse hast, das Projekt bei der Konzeption, als Entwickler, Designer, Tester oder auch finanziell zu unterstützen, melde Dich einfach!

## Installation der Entwicklungsumgebung

Die Wingolfsplattform basiert serverseitig auf [Ruby on Rails](http://rubyonrails.org/), clientseitig auf [Vue.js](https://vuejs.org).

Auf einer Entwicklungsmaschine mit [Docker](https://www.docker.com) installierst Du die Entwicklungsversion der Wingolfsplattform wie folgt:

```bash
git clone git@github.com:fiedl/wingolfsplattform.git
cd wingolfsplattform
git clone git@github.com:fiedl/your_platform.git
docker-compose build
```

Falls Du die Umgebung alternativ lieber großteils ohne Docker installieren möchtest, guck Dir am Besten unseren alten [Getting-Started-Guide](https://github.com/fiedl/wingolfsplattform/wiki/Getting-Started) an.

### Web-Oberfläche

Starte die Web-Oberfläche mit

```bash
docker-compose run rails bundle exec rake db:create db:migrate db:seed
docker-compose up rails
```

und rufe danach http://localhost:3000 auf.

### Konsole

Mit der Rails-Konsole kannst Du auch ohne Web-Oberfläche auf alles zugreifen:

```bash
docker-compose run console
```

### Tests

Tests vollständig durchlaufen lassen:

```bash
docker-compose run tests
```

Während der Entwicklung kannst Du auch [guard](https://github.com/guard/guard) laufen lassen. Dieses Tool lässt, wenn Du Code-Dateien veränderst, immer die passenden Tests laufen.

```bash
docker-compose run guard
```

### Security

Bitte macht euch mit dem [Rails-Security-Guide](http://guides.rubyonrails.org/security.html) vertraut. Kontrolliert euren Code bitte außerdem mit [`brakeman`](https://github.com/presidentbeef/brakeman).

### Datenbank

Datenbank in eine SQL-Datei exportieren:

```bash
docker-compose run rails bundle exec ruby script/dump
```

Dies erzeugt eine SQL-Datei mit Zeitstempel im Verzeichnis `backups/sql_dumps`.

SQL-Datei importieren:

```bash
docker-compose run rails bash -c "mysql -h mysql -u root --password=secret -D wingolfsplattform_development" < /path/to/sql/file.sql
```


## Screencasts

* [Plattform-Podcast, Ep. #1](https://plattformpodcast.com/1)
* [Was kann die Plattform?](https://youtu.be/xAiQo1wOq5Y)
* [Wie sende ich eine Semesterstatistik an den Vorort?](https://youtu.be/BeqTjedVP8Y)
* [Wie abonniere ich meinen Veranstaltungskalender?](https://youtu.be/ryHnG9fsglg)
* [Wie trage ich ein Semesterprogramm ein?](https://youtu.be/wmP_4n0SGpM)
* [Wie binde ich Veranstaltungen auf einer öffentlichen Homepage ein?](https://youtu.be/4wAdcpLiAfE)
* [Wie erstelle ich eine Amtsträger-Obergruppe?](https://youtu.be/AjROKOdXA8M)
* Weitere Screencasts: https://plattformpodcast.com

## Weiterführende Informationen

* [Trello Board "AK Internet: Entwicklung"](https://trello.com/board/ak-internet-entwicklung/50006d110ad48e941e8496d2)
* YourPlatform-Projekt, https://github.com/fiedl/your_platform


## Urheber, Mitarbeiter und Lizenz

Copyright (c) 2012-2021, Sebastian Fiedlschuster

Mitarbeiter: Jörg Reichardt, Manuel Zerpies, Joachim Back, Willi Helwig, Falk Schimweg, Felix Plapper

Der Quellcode ist unter den Lizenzbestimmungen der [GNU Affero General Public License (AGPL)](AGPL.txt) veröffentlicht. Hiervon sind explizit ausgenommen die Grafiken und Schriftarten in den Verzeichnissen [app/assets/images](app/assets/images) und [app/assets/fonts](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)](AGPL.txt). Explicitely excluded are the images and fonts in the directories [app/assets/images](app/assets/images) and [app/assets/fonts](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](AGPL.txt) 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/>.

Vorrangige Sonderbestimmung für den VAW e.V.: Aufgrund des sog. neuen Entwicklungsmodells ist eine Nutzung der Software durch Philister des VAW e.V. ab Commit `c748222315` und später an die finanzielle Vergütung der jeweiligen Entwicklungsarbeit geknüpft.