hendrixroa / skelleton-api Public

Notifications You must be signed in to change notification settings
Fork 0
Star 2

API builded with DI (Dependency Injection) and Swagger definitions for Typescript Rest and automated generation of swagger spec.

2 stars 0 forks Branches Tags Activity

Notifications

Name		Name	Last commit message	Last commit date
Latest commit History 1 Commit
env		env
src		src
test		test
.dockerignore		.dockerignore
.eslintignore		.eslintignore
.eslintrc.js		.eslintrc.js
.gitignore		.gitignore
.prettierrc		.prettierrc
.yarnclean		.yarnclean
Dockerfile		Dockerfile
Makefile		Makefile
README.md		README.md
docker-compose.yml		docker-compose.yml
nest-cli.json		nest-cli.json
nodemon.json		nodemon.json
ormconfig.js		ormconfig.js
package.json		package.json
tsconfig.json		tsconfig.json
yarn.lock		yarn.lock

Repository files navigation

Skelleton API

API builded with DI (Dependency Injection) and Swagger definitions for Typescript Rest and automated generation of swagger spec.

Features

Integrated with bunyan logs.
Easy integration with Microservices.
Swagger file generation
Pre-built middlewares
Response schemas
Integrated with Prettier and code format precommit webhook.
Migrated to Nest.js
Use AWS Cognito as authentication users
User entity and authentication endpoints. And more...

Requirements

yarn
node.js
postgres running in localhost (or any driver that you prefer, see ormconfig.js)
redis running in localhost
aws cognito credentials for authentication.
make and build essentials for Unix

How to use

Run yarn to install dependencies
Run APP=api make dev_app
Go to http://localhost:3000/docs to play with the API
Enjoy!

About

API builded with DI (Dependency Injection) and Swagger definitions for Typescript Rest and automated generation of swagger spec.

docker aws typescript dependency-injection swagger cognito node-js nestjs nestjs-backend

Report repository

Releases

No releases published

Packages

No packages published

Languages