https://github.com/gregonnet/ngrx-workshop-devopenspace-2018-api
The API for the ngrx workshop
https://github.com/gregonnet/ngrx-workshop-devopenspace-2018-api
nestjs typescript
Last synced: 17 days ago
JSON representation
The API for the ngrx workshop
- Host: GitHub
- URL: https://github.com/gregonnet/ngrx-workshop-devopenspace-2018-api
- Owner: GregOnNet
- Created: 2018-10-07T20:02:23.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-10-08T13:05:11.000Z (over 7 years ago)
- Last Synced: 2025-03-17T03:43:06.930Z (about 1 year ago)
- Topics: nestjs, typescript
- Language: TypeScript
- Size: 382 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Workshop API
Die API stellt einen die Taskboard API zur Verfügung.
## Contents
- [Setup](#installation-und-start)
- [Update](#update)
- ☁️ [HTTP API](#Dokumentation)
## Installation und Start
Bitte lade das Repository herunter und installiere sie, wie im folgenden Snippet beschrieben.
Nach der Installation läuft die API lokal und benötigt keinen Zugriff auf andere Netzwerkressourcen.
> **Hinweis** Nachdem `npm start` ausgeführt wurde, startet die API unter https://localhost:3000.
```bash
# Herunterladen
git clone https://github.com/GregOnNet/leipzig-2018-10-12-api.git
# In das API Verzeichnis wechseln
cd leipzig-2018-10-12-api
# Abhängigkeiten installieren
npm install
# API starten
npm start
```
## Update
Wenn diese API Aktualisierungen oder Bugfixes erfährt, kannst du diese wie
folgt beziehen.
```bash
cd leipzig-2018-10-12-api
git reset --hard # Setzt "database/" zurück
git pull # Lädt Änderungen herunter
npm ci # Installiert ggf. neue Pakete
```
## Dokumentation
Die RESTful APIs _Taskboard_ und _Dashboard_ wurden mit
[Swagger](https://swagger.io/) dokumentiert. Nach dem starten der API befindet
sich unter http://localhost:3000/api/ eine interaktive Dokumentation.
