https://github.com/lklich/nestjs-typeorm-rest-example
Przykład wykorzystania NestJS do API REST opartego na TypeORM (CRUD, logowanie, relacje). Projekt zawiera dokumentację źródeł. A NestJS + TypeORM example. API REST (CRUD, log, Database relationships).
https://github.com/lklich/nestjs-typeorm-rest-example
api auth crud nest nestjs nodejs rest typeorm typescript
Last synced: 3 months ago
JSON representation
Przykład wykorzystania NestJS do API REST opartego na TypeORM (CRUD, logowanie, relacje). Projekt zawiera dokumentację źródeł. A NestJS + TypeORM example. API REST (CRUD, log, Database relationships).
- Host: GitHub
- URL: https://github.com/lklich/nestjs-typeorm-rest-example
- Owner: lklich
- License: mit
- Created: 2023-06-25T13:18:58.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-06-25T14:37:26.000Z (almost 2 years ago)
- Last Synced: 2025-02-26T09:31:04.488Z (3 months ago)
- Topics: api, auth, crud, nest, nestjs, nodejs, rest, typeorm, typescript
- Language: TypeScript
- Homepage:
- Size: 126 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# NestJS_TypeORM_REST_example
Przykład wykorzystania NestJS do API REST opartego na TypeORM. Projekt zawiera dokumentację źródeł.
# Krótko o NestJS
Jest to framework do budowania aplikacji API REST w języku TypeScript (oczywiście da się go wykorzystać także do budowania monolitów z renderowaniem po stronie serwera). Główną zaletą frameworka jest jego podomieństwo do Angulara oraz porz ądek. Nest narzuca strukturę katalogów, konwencję nazw plików oraz podział aplikacji na fragmenty. Dzięki temu aplikacje tworzone w NestJS mają podobną strukturę. Dzięki temu programiści mogą szybciej wdrożyć się w projekt. NestJS pozwala tworzyć różnego rodzaju aplikacje serwerowe, a dzięki wygodnemu CLI praca staje się lekka i wydajna.
Co warte podkreślenia, autorem frameworka jest Kamil Myśliwiec https://kamilmysliwiec.com/
Strona projektu NestJS: https://nestjs.com/
# Instalacja
Aby pobrać tę aplikację, wykonaj poniższe polecenia. Oczywiście w systemie musi być zasinstalowany Git.
```
git clone https://github.com/lklich/-NestJS_TypeORM_REST_example.git
cd NestJS_TypeORM_REST_example
npm install
```
Teraz otwórz sklonowany projekt w ulubionym IDE$, np. Visual Studio Code.
## Ustawienie zmiennej środowiskowej
W zależności od tej zmiennej, aplikacja użyje odpowiedniego pliku konfiguracyjnego.
```
Windows (CMD): set NODE_ENV=development
Linux/MacOS: export NODE_ENV=development
```
W tym przypadku wykorzystany zostanie plik *development.env*.
## Konfiguracja połączenia z bazą
W *src/common/envs* znajdują się dwa pliki konfiguracyjne. Otwórz do edycji plik **development.env** i popraw w nim parametry konfiguracyjne dla bazy danych MySQL:
```
PORT=3000
DATABASE_HOST=localhost
DATABASE_NAME=nazwa_bazy
DATABASE_USER=uzytkownik
DATABASE_PASSWORD=haslo
DATABASE_PORT=3306
```
Zapisz plik i uruchom serwer poleceniem:
```
npm run start:dev
```
Zajrzyj do dokumentacji w zakładce WIKI, aby zapoznać sie krok po kroku z tworzeniem oprogramowania w NestJS.
*Życzę miłej lektury*
Leszek Klich