codever Download - codever Quellcode herunterladen

codever

Website-Daten

1.0.0

Herunterladen

⚡ ⚡? ️ Lesezeichen und Snippets Manager für Entwickler & Co? ⚡️

Verwenden Sie unsere Howto -Seiten, um Sie zum Laufen zu bringen und bei der Verwaltung Ihrer Lesezeichen und Code -Snippets Zeit und Nerven zu sparen. Die folgenden Helfer und Erweiterungen unterstützen Sie unterwegs:

Erweiterungen


Lesezeichen	Chromverlängerung	Firefox Addon	Intellij Plugin	VSCODE -Erweiterung

Beispiel für Chrome -Erweiterungsnutzung - Speichern von Snippet

Speichern Sie die Verwendung von Chromverlängerung in der Chromverlängerung

Die anderen Erweiterungen funktionieren nach demselben Prinzip mehr oder weniger

Öffentliche Lesezeichen

Würde öffentliche Lesezeichen werden regelmäßig auf GitHub unter Codeverdotdev/Lesezeichen veröffentlicht.

Setup (Entwicklung oder Selbsthosting)

Mit diesen Anweisungen werden Sie für die Entwicklung und Testzwecke eine Kopie des Projekts auf Ihrer lokalen Maschine in Betrieb genommen.

Das Projekt wird mit dem mittleren Stack und dem Schlüssel zur Authentifizierung und Autorisierung entwickelt: Komponentengraph

Das Projekt enthält zwei Apps

Codever-UI, das die Benutzeroberfläche ausmacht. Dies verwendet mit eckigen und eckigen CLI.
Codever-API, das die API ist, die die Benutzeroberfläche unterstützt. Es verwendet ExpressJs mit MongoDB und Schlüsselkloak. Siehe die OpenAPI -Spezifikation

Voraussetzungen

Was Sie benötigen, um diese App auszuführen:

node und npm (wir empfehlen die Verwendung von NVM)
- Stellen Sie sicher, dass Sie zumindest den Knoten ausführen ( v16.xx +) und npm ( 8.xx +).
Nodemon - npm install -g nodemon
Docker - Wir empfehlen die Verwendung von Docker Desktop

Docker und Docker-Compose werden derzeit nur für die lokale Entwicklung verwendet

Installation ( Entwicklungsaufbau )

Starten Sie den MongoDB und den KeyCloak -Server

Euen Wenn Sie docker compose Sie erstmals die folgenden -Dkeycloak.migration.action=import Line:

    # command: -Dkeycloak.migration.action=import -Dkeycloak.migration.provider=dir -Dkeycloak.migration.dir=/tmp/keycloak/export-import -Dkeycloak.migration.strategy=IGNORE_EXISTING

In der Docker-Compose-Datei, damit das anfängliche Schlüsselkloak-Setup (Realm und Benutzer) geladen wird .

Euen Für weitere Startups von Docker-compose sollten Sie diese Zeile wieder kommentieren , da sie schneller beginnt

docker-compose up

Verwenden Sie -d , um es im Hintergrund auszuführen

Installieren und Ausführen (Frontend & Backend)

Sie möchten, dass die Backend -API zuerst mit den folgenden Befehlen ausgeführt wird:

 # install
nvm use   # only if you are using nvm
npm install

# run
npm run frontend # to run the frontend
npm run backend # to run the backend

# alternatively run in parallel
npm start

oder in einer Zeile nvm use; npm install; npm start

Das beginnt

Die API mit Nodemon unter http: // localhost: 3000/api und achtet nach Codeänderungen im Backend und nach automatisch neu ein.
Die Frontend erhältlich unter http: // localhost: 4200. Melden Sie sich im anfänglichen Keycloak -Setup an, das für Sie konfigurierte Benutzer/Kennwort mock/mock anmelden. Einige Lesezeichen werden ursprünglich mit Ihrem Konto geladen, sodass Sie damit beginnen können, mit ihnen zu spielen.

Sie können Ihren eigenen Testbenutzer oder andere zusätzliche Benutzer erstellen, indem Sie den Screenshots in einem Schlüsselkloak -Benutzer hinzufügen, um ihn zu erstellen.

Um automatisch YouTube -Videos veröffentlichen Datum und Dauer zu dem Titel hinzuzufügen, müssen Sie eine nodemon.json -Datei basierend auf der Backend/nodemon.json.example erstellen und Ihre eigene YouTube -API -Taste hinzufügen

Schlüsselcloak

KeyCloak Admin -Konsole erreichbar unter http: // localhost: 8080/auth mit dem user/kennwort admin/Pa55w0rd (siehe Docker Compose -Datei)

Testen

E2E (Integrationstests) mit Zypressen

Keycloak und MongoDB müssen wie oben angegeben gestartet werden (Befehl docker-compose up )

Führen Sie den Integrationstest aus, indem Sie den folgenden Befehl ausgeben.

 cd apps/codever-ui
npm run cy:run

Um Cypress zu öffnen, können Sie die folgende Aufgabe ausführen npm run cy:open

API (Backend)

Integrationstests

Keycloak und MongoDB müssen wie oben angegeben gestartet werden (Befehl docker-compose up )

Führen Sie den Integrationstest aus, indem Sie den folgenden Befehl ausgeben.

 cd apps/codever-api
npm run integration-tests

Ein Bericht wird erstellt.

Debuggen

UI (Frontend)

Entwicklerwerkzeuge in Chrombrowsern

Sie können die Entwickler -Tools in Browsern auf Chrombasis (z. B. Chrom, Mut) verwenden. Navigieren Sie zu Quellen und der Datei, die Sie Ihre Pausenpunkte festlegen möchten, wie im folgenden Beispiel:

Chrom-Dev-Tools-Debugging