Improved description of development
parent
224ede32ac
commit
c1a75c9dfd
115
Entwicklung.md
115
Entwicklung.md
@ -2,9 +2,10 @@
|
||||
|
||||
1. [Einrichtung](#einrichtung)
|
||||
* [VS Code](#vs-code)
|
||||
2. [Versionierung](#versionierung)
|
||||
3. [Branches](#branches)
|
||||
4. [Pull Requests](#pull-requests)
|
||||
2. [Bot Einstellungen](#bot-einstellungen)
|
||||
3. [Versionierung](#versionierung)
|
||||
4. [Branches](#branches)
|
||||
5. [Pull Requests](#pull-requests)
|
||||
|
||||
## Einrichtung
|
||||
|
||||
@ -28,7 +29,14 @@ Nun müssen Sie in den Ordner des Projektes gehen.
|
||||
cd sh_gismo
|
||||
```
|
||||
|
||||
Dort erstellen und aktivieren Sie ein VirtualEnv von Python:
|
||||
Um zu testen, ob Sie alles richtig eingerichtet haben, können Sie den folgenden Befehl Ausführen.
|
||||
Dieser sollte einen Ordner ```dist``` erstellen.
|
||||
|
||||
```sh
|
||||
cpl build
|
||||
```
|
||||
|
||||
Als nächstes erstellen und aktivieren Sie ein VirtualEnv von Python:
|
||||
|
||||
```sh
|
||||
# erstellen:
|
||||
@ -40,6 +48,30 @@ source venv/bin/activate
|
||||
.\venv\Scripts\activate
|
||||
```
|
||||
|
||||
Nachdem das venv nun erstellt wurde, benötigen noch die [CPL](https://git.sh-edraft.de/sh-edraft.de/sh_cpl).
|
||||
Diese Installieren Sie in der Virtuellen Umbebung nach dieser [Anleitung](https://docs.sh-edraft.de/cpl/setup.html#install-the-package).
|
||||
|
||||
Führen Sie den Befehl ```cpl v``` aus, um zu sehen ob alles richtig installiert wurde.
|
||||
Wenn der Befehl bei ihnen lief, können Sie nun weitere Pakete des Bot installieren.
|
||||
|
||||
```sh
|
||||
cpl install
|
||||
```
|
||||
|
||||
Der Befehl installiert alle Abhängikeiten, die in der Projektdatei angegeben sind.
|
||||
|
||||
Nach der Installation starten Sie den Bot:
|
||||
|
||||
```sh
|
||||
cpl start
|
||||
# Wenn Sie Entwickeln wollen:
|
||||
cpl dev
|
||||
# Wenn Sie Testen wollen:
|
||||
cpl test
|
||||
# Wenn Sie im Production Modus testen wollen:
|
||||
cpl prod
|
||||
```
|
||||
|
||||
Nun richten Sie die IDE ein, die Sie verwenden wollen.
|
||||
|
||||
### VS Code
|
||||
@ -49,7 +81,6 @@ Um adequat mit Python arbeiten zu können benötigen Sie ein paar Extensions:
|
||||
* [Pylance](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance)
|
||||
* [Python](https://marketplace.visualstudio.com/items?itemName=ms-python.python)
|
||||
* [Python Docstring Generator](https://marketplace.visualstudio.com/items?itemName=njpwerner.autodocstring)
|
||||
* [Python Indent](https://marketplace.visualstudio.com/items?itemName=KevinRose.vsc-python-indent)
|
||||
* [Python Test Explorer for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=LittleFoxTeam.vscode-python-test-adapter)
|
||||
* [python-snippets](https://marketplace.visualstudio.com/items?itemName=cstrap.python-snippets)
|
||||
* [Importmagic](https://marketplace.visualstudio.com/items?itemName=brainfit.vscode-importmagic)
|
||||
@ -62,6 +93,78 @@ ImportMagic: Resolve Import -> Alt+Enter
|
||||
|
||||
VS Code sollten Sie dann einmal neustarten und die Entwicklung kann ab dann losgehen.
|
||||
|
||||
## Bot Einstellungen
|
||||
|
||||
Nachdem Sie nun das Projekt auf ihren PC Kopiert haben und alle Schritte bfolgt haben, sollten Sie folgende Ordnerstrucktur vorfinden:
|
||||
|
||||
```text
|
||||
sh_gismo/
|
||||
dist/
|
||||
src/
|
||||
gismo/
|
||||
gismo_cli/
|
||||
gismo_core/
|
||||
gismo_data/
|
||||
modules/
|
||||
modules_core/
|
||||
tools/
|
||||
venv/
|
||||
.gitignore
|
||||
cpl-workspace.json
|
||||
LICENSE
|
||||
README.md
|
||||
```
|
||||
|
||||
In den Ordner ```src/gismo/``` müssen die Einstellungen in den Dateien Appsettings gespeichert werden.
|
||||
Sie sollten nur die Datei ```appsettings.json``` sehen, in dieser Datei können Sie ihre Einstellungen auch vornehmen dies ist jedoch nicht zu Empfehlen.
|
||||
|
||||
Sie sollten eine Datei erstellen, die anstatt des Platzhalters ihren Rechnernamen oder die Umbebung in der Sie arbeiten enthalten.
|
||||
Beispiele:
|
||||
|
||||
```text
|
||||
Umgebung:
|
||||
appsettings.production.json
|
||||
appsettings.staging.json
|
||||
appsettings.development.json
|
||||
|
||||
Rechnername:
|
||||
appsettings.MEIN-PC.json
|
||||
|
||||
Standard:
|
||||
appsettings.json
|
||||
```
|
||||
|
||||
Sie können folgenden Inhalt in die Datei Kopieren, Sie müssen unbedingt die fehlenden Werte eintragen!:
|
||||
|
||||
```json
|
||||
{
|
||||
"DatabaseSettings": {
|
||||
"Host": "",
|
||||
"User": "",
|
||||
"Password": "",
|
||||
"Database": "",
|
||||
"Charset": "utf8mb4",
|
||||
"UseUnicode": "true",
|
||||
"Buffered": "true",
|
||||
"AuthPlugin": "mysql_native_password"
|
||||
},
|
||||
"Discord": {
|
||||
"Token": ""
|
||||
},
|
||||
"Bot": {
|
||||
"Prefix": "",
|
||||
"Servers": [
|
||||
{
|
||||
"Id": "",
|
||||
"LoginMessageChannelId": "",
|
||||
"LoginMessage": "",
|
||||
"MessageDeleteTimer": 2
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Versionierung
|
||||
|
||||
Major.Minor.Micro
|
||||
@ -194,4 +297,4 @@ Danach wird der Branch gelöscht welcher gemerged wurde.
|
||||
[pip-url]: https://pip.sh-edraft.de
|
||||
[python]: https://www.python.org/
|
||||
[pip]: https://pypi.org/project/pip/
|
||||
[pr]: https://git.sh-edraft.de/sh-edraft.de/sh_gismo/pulls
|
||||
[pr]: https://git.sh-edraft.de/sh-edraft.de/sh_gismo/pulls
|
||||
|
||||
Reference in New Issue
Block a user