https://github.com/mikro-orm/nestjs-realworld-example-app

Example real world backend API built with NestJS + MikroORM
https://github.com/mikro-orm/nestjs-realworld-example-app

mikro-orm nestjs realworld realworld-backend

Last synced: 3 days ago
JSON representation

Example real world backend API built with NestJS + MikroORM

• Host: GitHub
• URL: https://github.com/mikro-orm/nestjs-realworld-example-app
• Owner: mikro-orm
• License: mit
• Created: 2019-11-14T23:21:24.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2024-10-29T08:15:20.000Z (3 months ago)
• Last Synced: 2024-10-29T09:32:23.832Z (3 months ago)
• Topics: mikro-orm, nestjs, realworld, realworld-backend
• Language: TypeScript
• Homepage: https://realworld.io/
• Size: 4 MB
• Stars: 277
• Watchers: 7
• Forks: 72
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# ![NestJS](project-logo.png)

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

> Rewrite of https://github.com/lujakob/nestjs-realworld-example-app to MikroORM.

----------

# Getting started

## Installation

    

Install dependencies

    

    yarn

Copy config file and set JsonWebToken secret key

    cp src/config.ts.example src/config.ts

    

----------

## Database

The example codebase uses [MikroORM](https://mikro-orm.io/) with a MySQL database.

Copy MikroORM config example file for database settings and adjust the connection settings.

    cp src/mikro-orm.config.ts.example src/mikro-orm.config.ts

    

Now you can start the application with `yarn start`. It will automatically

create the database and run initial migration that sets up the database 

schema.

----------

## NPM scripts

- `yarn start` - Start application

- `yarn start:dev` - Start application in watch mode

- `yarn test` - run Jest test runner 

- `yarn start:prod` - Build application

----------

## 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

----------

## Start application

- `yarn start`

- Test api by browsing to `http://localhost:3000/api/articles`

- View automatically generated swagger api docs by browsing to `http://localhost:3000/docs`

- Run e2e tests from the `gothinkster/realworld` repository with `yarn test:e2e`

----------

# 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.