https://github.com/samialdury/nodejs-api

Batteries-included Node.js API template with best practices in mind.
https://github.com/samialdury/nodejs-api

commitlint conventional-commits docker envey eslint husky lint-staged node nodejs pino pnpm prettier template typescript zod

Last synced: about 2 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/samialdury/nodejs-api
• Owner: samialdury
• License: mit
• Created: 2023-08-11T15:08:01.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-06-24T17:58:41.000Z (over 1 year ago)
• Last Synced: 2025-08-15T21:18:58.507Z (about 2 months ago)
• Topics: commitlint, conventional-commits, docker, envey, eslint, husky, lint-staged, node, nodejs, pino, pnpm, prettier, template, typescript, zod
• Language: TypeScript
• Homepage:
• Size: 665 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Node.js API template

[![CI status](https://github.com/samialdury/nodejs-api/actions/workflows/ci.yml/badge.svg)](https://github.com/samialdury/nodejs-api/actions/workflows/ci.yml)

[![license](https://img.shields.io/github/license/samialdury/nodejs-api)](LICENSE)

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

## Usage

This template is included in the [@samialdury/create](https://github.com/samialdury/create) CLI tool and it's the recommended way to use it.

```sh

bunx @samialdury/create nodejs-api

```

You can also create a new GitHub repository from this template directly by clicking [here](https://github.com/new?template_name=nodejs-api&template_owner=samialdury), and then running the following command in the root directory of the repository, replacing `your-project-name` with the name of your project.

```sh

# 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](LICENSE)