An open API service indexing awesome lists of open source software.

https://github.com/mutoe/nestjs-realworld-example-app

Use TDD to develop a Realworld project based on Nestjs + TypeORM
https://github.com/mutoe/nestjs-realworld-example-app

Last synced: 12 months ago
JSON representation

Use TDD to develop a Realworld project based on Nestjs + TypeORM

Awesome Lists containing this project

README

          

# ![Nestjs Realworld Example App](project-logo.png)

> ### NestJS codebase containing real world examples (CRUD, auth, advanced patterns, etc) that adheres to the [RealWorld](https://github.com/gothinkster/realworld-example-apps) API spec.

----------

# Getting started

```bash
pnpm install
cp .env.template .env
docker compose up
```

- Open `http://localhost:3000/api/articles` in your favourite browser`
- Open `http://localhost:3000/docs` to view swagger API document

----------

## API Specification

This application adheres to the api specifications set by the [Thinkster](https://github.com/gothinkster) team. This helps mix and match any backend with any other frontend without conflicts.

> [Full API Spec](https://github.com/gothinkster/realworld/tree/master/api)

More information regarding the project can be found here https://github.com/gothinkster/realworld

----------

# Authentication

This applications uses JSON Web Token (JWT) to handle authentication. The token is passed with each request using the `Authorization` header with `Token` scheme. The JWT authentication middleware handles the validation and authentication of the token. Please check the following sources to learn more about JWT.