Skip to content

Latest commit

 

History

History
91 lines (50 loc) · 2.05 KB

README.md

File metadata and controls

91 lines (50 loc) · 2.05 KB

Node/Express/TypeOrm

NestJS codebase containing CRUD, auth, advanced patterns, etc from shellyeah.

Getting started

Installation

Clone the repository

git clone https://github.com/shelleycavaness/nov_nest.git

Switch to the repo folder

cd nest_orm_nov

Install dependencies

npm install

Copy config file and set JsonWebToken secret key

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

Create a new mysql database with the name eco-challenge
(or the name you specified in the ormconfig.json)

Copy TypeORM config example file for database settings

cp ormconfig.json.example

Set mysql database settings in ormconfig.json

{
  "type": "mysql",
  "host": "localhost",
  "port": 3306,
  "username": "your-mysql-username",
  "password": "your-mysql-password",
  "database": "nestjsrealworld",
  "entities": ["src/**/**.entity{.ts,.js}"],
  "synchronize": true
}

Start local mysql server and create new database 'nestjsrealworld'

On application start, tables for all entities will be created.

NPM scripts

  • npm start - Start application
  • npm run start:watch - Start application in watch mode
  • npm run test - run Jest test runner
  • npm run start:prod - Build application

Start application

  • npm start
  • Test api with http://localhost:3000/api/players in your favourite browser

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.

Swagger API docs

This example repo uses the NestJS swagger module for API documentation. NestJS Swagger - www.swagger.io