Skip to content
Node.js api boilerplate built on TypeScript
TypeScript JavaScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.vscode
src
.dockerignore
.env.example
.eslintignore
.eslintrc.js
.gitignore
.lintstagedrc
.prettierignore
.prettierrc
.travis.yml
Dockerfile
LICENSE
README.md
docker-compose.yml
jest.config.js
nodemon.json
package-lock.json
package.json
swagger.json
tsconfig.json
wallaby.js

README.md

Node.js API TypeScript Starter

A time saver API boilerplate built on TypeScript

Build status

Motivation

There are others boilerplates, but in this one I'm including my personal preferences. My proposal is to help other people finding good practices and create projects faster with this boilerplate.

Project structure explanation

  • WIP

Packages Included

  • Express.js (Web server)
  • PostgreSQL (Default database)
  • Prettier (Code formatting stuff)
  • ESLint (Static code analyzer)
  • TypeORM (Database access)

Future Roadmap

  • Improve debugging setup for vscode
  • Authentication and Authorization (jwt)
  • Base controller
  • Catching 404
  • Set up events
  • Model validation
  • Swagger docs
  • Unit testing (jest)
  • Object mapping
  • Configure sorting and filtering
  • Verify a rest api check list
  • Path aliases
  • Validate configuration
  • Logging

Disclaimer

This template is still working in progress, the architecture used in this boilerplate is for general purposes.

You can’t perform that action at this time.