Überarbeitung Verbrauchsausweis+ Berechnung
This commit is contained in:
67
README.md
67
README.md
@@ -1,17 +1,10 @@
|
||||
[![Contributors][contributors-shield]][contributors-url]
|
||||
[![Forks][forks-shield]][forks-url]
|
||||
[![Stargazers][stars-shield]][stars-url]
|
||||
[![Issues][issues-shield]][issues-url]
|
||||
[![MIT License][license-shield]][license-url]
|
||||
|
||||
<!-- PROJECT LOGO -->
|
||||
<br />
|
||||
<div align="center">
|
||||
<a href="https://github.com/IBCornelsen/database">
|
||||
<img src="images/logo.png" alt="Logo" width="80" height="80">
|
||||
<a href="https://github.com/IBCornelsen/online-energieausweis">
|
||||
<img src="public/images/header/logo-big.png" alt="Logo" width="240" height="80">
|
||||
</a>
|
||||
|
||||
<h3 align="center">IBC Online Energieausweis</h3>
|
||||
<h3 align="center">IBCornelsen Online Energieausweis</h3>
|
||||
|
||||
<p align="center">
|
||||
Online Energieausweis erstellen - IBCornelsen
|
||||
@@ -19,11 +12,11 @@
|
||||
<a href="https://docs.ibcornelsen.de/storage/"><strong>Dokumentation »</strong></a>
|
||||
<br />
|
||||
<br />
|
||||
<a href="https://github.com/IBCornelsen/database">Demo</a>
|
||||
<a href="https://github.com/IBCornelsen/online-energieausweis">Demo</a>
|
||||
·
|
||||
<a href="https://github.com/IBCornelsen/database/issues">Bug gefunden?</a>
|
||||
<a href="https://github.com/IBCornelsen/online-energieausweis/issues">Bug gefunden?</a>
|
||||
·
|
||||
<a href="https://github.com/IBCornelsen/database/issues">Feature Anfordern</a>
|
||||
<a href="https://github.com/IBCornelsen/online-energieausweis/issues">Feature Anfordern</a>
|
||||
</p>
|
||||
</div>
|
||||
|
||||
@@ -38,13 +31,9 @@
|
||||
|
||||
## Beschreibung
|
||||
|
||||
Dies ist das Repository für die Datenbank des IBCornelsen. Eine Demo kann direkt über GitHub heruntergeladen und mit **Docker** gestartet werden.
|
||||
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 Umsetzung einer neuen, verbesserten Datenbankstruktur die aktuelle Probleme mit Hinsicht auf die Skalierung unserer Architektur lösen wird.
|
||||
|
||||
Hier eine Veranschaulichung:
|
||||
|
||||

|
||||
Momentan arbeiten wir an der generellen Struktur, um eine problemlose Skalierung unserer Services gewährleisten zu können.
|
||||
|
||||
### Anforderungen
|
||||
|
||||
@@ -54,32 +43,33 @@ Für dieses Projekt benötigst du:
|
||||
|
||||
* docker
|
||||
* Installationsanleitungen für **docker** kannst du [hier](https://docs.docker.com/engine/install/) finden.
|
||||
* NodeJS
|
||||
* Downloads für Node stehen [hier](https://nodejs.org/en) zur Verfügung.
|
||||
* Einen Package Manger deiner Wahl, du kannst **NPM**, **pNPM** oder auch **Yarn** verwenden. Wir empfehlen **pNPM** da er in den meisten Situationen schneller ist und dabei das gleiche Feature Set wie **NPM** bietet.
|
||||
* 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/database.git
|
||||
```
|
||||
```sh
|
||||
git clone https://github.com/IBCornelsen/online-energieausweis
|
||||
```
|
||||
|
||||
2. Führe `docker-compose` aus.
|
||||
|
||||
```bash
|
||||
docker-compose up --build
|
||||
```
|
||||
```bash
|
||||
docker-compose up --build
|
||||
```
|
||||
|
||||
3. Öffne `localhost:3000` in deinem Browser.
|
||||
|
||||
## Nächste Schritte
|
||||
|
||||
* [ ] Verteilte Datenbankstruktur
|
||||
* [ ] Funktionierender Checkout Flow
|
||||
* [ ] Performance Optimierungen
|
||||
* [ ] Umstieg auf PostgreSQL
|
||||
* [ ] Umzug der alten Daten
|
||||
* [ ] Automatische Tests
|
||||
* [ ] Dokumentation
|
||||
|
||||
See the [open issues](https://github.com/IBCornelsen/database/issues) for a full list of proposed features (and known issues).
|
||||
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
|
||||
|
||||
@@ -99,15 +89,4 @@ Veröffentlicht unter der GPL-3.0 Lizenz. Siehe `LICENSE` für mehr Information.
|
||||
|
||||
IBCornelsen - [info@ibcornelsen.de](mailto://info@ibcornelsen.de)
|
||||
|
||||
Organisation: [https://github.com/IBCornelsen/database](https://github.com/IBCornelsen/database)
|
||||
|
||||
[contributors-shield]: https://img.shields.io/github/contributors/IBCornelsen/database.svg?style=for-the-badge
|
||||
[contributors-url]: https://github.com/IBCornelsen/database/graphs/contributors
|
||||
[forks-shield]: https://img.shields.io/github/forks/IBCornelsen/database.svg?style=for-the-badge
|
||||
[forks-url]: https://github.com/IBCornelsen/database/network/members
|
||||
[stars-shield]: https://img.shields.io/github/stars/IBCornelsen/database.svg?style=for-the-badge
|
||||
[stars-url]: https://github.com/IBCornelsen/database/stargazers
|
||||
[issues-shield]: https://img.shields.io/github/issues/IBCornelsen/database.svg?style=for-the-badge
|
||||
[issues-url]: https://github.com/IBCornelsen/database/issues
|
||||
[license-shield]: https://img.shields.io/github/license/IBCornelsen/database.svg?style=for-the-badge
|
||||
[license-url]: https://github.com/IBCornelsen/database/blob/master/LICENSE
|
||||
Organisation: [https://github.com/IBCornelsen](https://github.com/IBCornelsen)
|
||||
Reference in New Issue
Block a user