Skip to content

alenworld/jenkins-test

Repository files navigation

ALENWORLD

Nest.js API. PostgreSQL, Redis

Project Introduction

Features

Authentication:
  • passport local strategy
  • jwt authentication
Session Storage:
  • PostgreSQL
  • Redis
Integration testing
  • supertest

Requirements

  • node >= 16
  • npm >= 8
  • postgresql >= 12.0
  • typescript >= 3.0

App Skeleton

├── src
│├── routes
││├── app
│││   └── ...
││├── v1
│││├── auth
││││   └── ...
│││└── users
││     └── ...
│├── dto
││└── ...
│├── filters
││└── ...
│├── guards
││└── ...
│├── main.ts
│└── pipes
│    └── ...
├── docker-compose.yml
├── index.js
├── nest-cli.json
├── package.json
├── package-lock.json
├── README.md
├── tsconfig.build.json
└── tsconfig.json

Running the API

Migrations

Local:

npm run build

npm run schema:sync

npm run migration

Docker:

sudo docker exec -it app bash

npm run migration

Development

To start the application in development mode, run:

npm run start:dev

Docker

sudo docker-compose up 

Set up environment

Example environments you can find in .env.example.

Swagger

Swagger documentation will be available on route:

http://localhost:3000/api

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors