Skip to content

Latest commit

 

History

History
34 lines (19 loc) · 1.19 KB

README.md

File metadata and controls

34 lines (19 loc) · 1.19 KB
Raw

Nestjs Realworld Example App

NestJS codebase containing real world examples (CRUD, auth, advanced patterns, etc) that adheres to the RealWorld API spec.

Getting started

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 team. This helps mix and match any backend with any other frontend without conflicts.

Full API Spec

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.