- [Beschreibung](#beschreibung)
- [Anforderungen](#anforderungen)
- [Installation](#installation)
- [Nächste Schritte](#nächste-schritte)
- [Beiträge zu unserer Arbeit](#beiträge-zu-unserer-arbeit)
- [License](#license)
- [Kontakt](#kontakt)
## Beschreibung
Dies ist das Repository für das Online-Energieausweis Projekt des IBCornelsen. Eine Demo kann direkt über GitHub heruntergeladen und mit **Docker** gestartet werden.
Momentan arbeiten wir an der generellen Struktur, um eine problemlose Skalierung unserer Services gewährleisten zu können.
### Anforderungen
Die meisten unserer Systeme sind für Ubuntu gedacht und darauf getestet worden. Viele Funktionen werden ebenfalls auf Windows verfügbar sein, allerdings können unerwartetes Verhalten und Fehler nicht ausgeschlossen werden.
Für dieses Projekt benötigst du:
* docker
* Installationsanleitungen für **docker** kannst du [hier](https://docs.docker.com/engine/install/) finden.
* Einen Package Manger deiner Wahl, du kannst **NPM**, **pNPM** oder auch **Yarn** verwenden. Wir empfehlen allerdings **bun** aufgrund der verbesserten Geschwindigkeit und dem gelieferten Feature Set, da **bun** sowohl einen Package Manager als auch einen Task Runner beinhaltet.
* Installationsanleitungen für **bun** kannst du [hier](https://bun.sh/) finden.
### Installation
1. Klone das Repository
```sh
git clone https://github.com/IBCornelsen/online-energieausweis
```
2. Führe `docker-compose` aus.
```bash
docker-compose up --build
```
3. Öffne `localhost:3000` in deinem Browser.
## Nächste Schritte
* [ ] Funktionierender Checkout Flow
* [ ] Performance Optimierungen
* [ ] Automatische Tests
* [ ] Dokumentation
Siehe alle [offenen issues](https://github.com/IBCornelsen/online-energieausweis/issues) für eine Liste der vorgeschlagenen Features (und bekannten Probleme).
## Beiträge zu unserer Arbeit
Wenn du Ideen, Vorschläge oder sonstige Anmerkungen haben solltest, schreck' nicht davor zurück dein Feature zu implementieren und eine Pull Request zu erstellen, wir sind **immer** offen für neues!
1. Erstelle einen **Fork** des Repos
2. Erstelle einen neuen Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Committe deine Änderungen (`git commit -m 'Add some AmazingFeature'`)
4. Pushe deine Änderungen auf den neuen Branch (`git push origin feature/AmazingFeature`)
5. Öffne eine Pull Request
## License
Veröffentlicht unter der GPL-3.0 Lizenz. Siehe `LICENSE` für mehr Information.
## Kontakt
IBCornelsen - [info@ibcornelsen.de](mailto://info@ibcornelsen.de)
Organisation: [https://github.com/IBCornelsen](https://github.com/IBCornelsen)