/nodejs-api

Batteries-included Node.js API template with best practices in mind.

Primary LanguageTypeScriptMIT LicenseMIT

Node.js API template

CI status license

Batteries-included Node.js API template with best practices in mind.

Usage

This template is included in the @samialdury/create CLI tool and it's the recommended way to use it.

bunx @samialdury/create nodejs-api

You can also create a new GitHub repository from this template directly by clicking here, and then running the following command in the root directory of the repository, replacing your-project-name with the name of your project.

# You should have pnpm installed globally
# prior to running these commands

make install
make prepare name=your-project-name

Stack

  • Node.js
  • TypeScript
  • ESLint
  • Prettier
  • Docker & Docker Compose
  • GitHub Actions & GitHub Container Registry
  • REST
  • MySQL
  • OpenAPI 3 & Swagger UI
  • OAuth2 & JWT (work in progress)
  • Pulumi IaC
  • local HTTPS

License

MIT