Skip to content

Commit

Permalink
doc: work on readme
Browse files Browse the repository at this point in the history
  • Loading branch information
KemoPanzah committed Jul 7, 2023
1 parent 716dbab commit b21a9a9
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 10 deletions.
20 changes: 15 additions & 5 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ Introduction
------------
decore Base is an out-of-the-box "Python to Vue.js" data application dashboard that helps you go from idea to view in a few simple steps. It is aimed at those who want to focus on the results of their algorithms, do scientific work or perform teaching and learning functions.

Notes
-----
**decore Base is currently a work in progress, only locally deployable, only available for Windows and not yet production ready**.

The recommended IDE is Visual Studio Code and all my comments and documentation here will also refer to vscode only.
Expand All @@ -14,6 +16,18 @@ The recommended IDE is Visual Studio Code and all my comments and documentation
:target: https://ko-fi.com/P5P2JCC5B
:alt: Buy me a coffee

This documentation was translated from German into English with Deepl.

Features and Integrations
-------------------------
- Ready-made SPA (Single Page Application) with Vue.js using Quasar Framework (https://github.com/quasarframework/quasar)
- Predefined Webapi for meta and actions with Flask (https://github.com/pallets/flask)
- Integrated ORM for data management and database interfaces (SQLite) powered by the great Peewee (https://github.com/coleifer/peewee)
- Data validation using Cerberus (https://github.com/pyeve/cerberus)
- Password management using pykeepass (https://github.com/libkeepass/pykeepass)

Please support these great projects!

Contribution
------------
The biggest help I can get right now is if you take a look at the project and tell me what you think. I am grateful for any criticism.
Expand Down Expand Up @@ -253,8 +267,4 @@ Sample application
------------------
To better understand how decore base works, it is best to look at the sample application. The application represents my continuous development of decore base.

https://github.com/KemoPanzah/decore_Base/tree/master/decore_base/sample

Notes
-----
This documentation was translated from German into English with Deepl.
https://github.com/KemoPanzah/decore_Base/tree/master/decore_base/sample
20 changes: 15 additions & 5 deletions README_DE.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ Introduction
------------
decore Base ist ein sofort einsatzbereites "Python to Vue.js" Datenanwendungs-Dashboard, das Ihnen hilft, in wenigen einfachen Schritten von der Idee zur Ansicht zu gelangen. Es richtet sich an diejenigen, die sich auf die Ergebnisse ihrer Algorithmen konzentrieren, wissenschaftlich arbeiten oder Lehr- und Lernfunktionen ausführen wollen.

Notes
-----
**decore Base ist derzeit noch in Arbeit, nur lokal einsetzbar, nur für Windows verfügbar und noch nicht produktionsreif**.

Die empfohlene IDE ist Visual Studio Code und alle meine Kommentare und Dokumentationen hier werden sich auch nur auf vscode beziehen.
Expand All @@ -14,6 +16,18 @@ Die empfohlene IDE ist Visual Studio Code und alle meine Kommentare und Dokument
:target: https://ko-fi.com/P5P2JCC5B
:alt: Buy me a coffee

Diese Dokumentation wurde mit Deepl vom Deutschen ins Englische übersetzt.

Features and Integrations
-------------------------
- Fertige SPA (Single Page Application) mit Vue.js mittels Quasar Framework (https://github.com/quasarframework/quasar)
- Vordefinierte Webapi für Meta und Aktionen mit Flask (https://github.com/pallets/flask)
- Integriertes ORM für die Datenverwaltung und Datenbankschnittstellen (SQLite) powered by the great Peewee (https://github.com/coleifer/peewee)
- Datenvalidierung mittels Cerberus (https://github.com/pyeve/cerberus)
- Passwortmanagment durch pykeepass (https://github.com/libkeepass/pykeepass)

Bitte unterstützt diese großartigen Projekte!

Contribution
------------
Die größte Hilfe, die ich im Moment bekommen kann, ist, wenn Sie einen Blick auf das Projekt werfen und mir sagen, was Sie davon halten. Ich bin für jede Kritik dankbar.
Expand Down Expand Up @@ -253,8 +267,4 @@ Sample application
------------------
Um besser zu verstehen, wie decore base funktioniert, ist es am besten, sich die Beispielanwendung anzusehen. Die Anwendung repräsentiert meine kontinuierliche Entwicklung von decore base.

https://github.com/KemoPanzah/decore_Sample

Notes
-----
Diese Dokumentation wurde mit Deepl vom Deutschen ins Englische übersetzt.
https://github.com/KemoPanzah/decore_Sample

0 comments on commit b21a9a9

Please sign in to comment.