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

Node.js project template designed to get you up and running quickly, whether you're building a CLI tool or a web server.
https://github.com/samialdury/nodejs-project

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

Last synced: 5 months ago
JSON representation

Node.js project template designed to get you up and running quickly, whether you're building a CLI tool or a web server.

• Host: GitHub
• URL: https://github.com/samialdury/nodejs-project
• Owner: samialdury
• License: mit
• Created: 2023-08-03T11:45:10.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-06-24T17:54:51.000Z (over 1 year ago)
• Last Synced: 2025-02-15T13:15:03.908Z (8 months ago)
• Topics: commitlint, conventional-commits, docker, envey, eslint, husky, lint-staged, node, nodejs, pino, pnpm, prettier, template, typescript, vitest, zod
• Language: JavaScript
• Homepage:
• Size: 252 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 project template

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

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

Node.js project template designed to get you up and running quickly, whether you're building a CLI tool or a web server.

## 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-project

```

You can also create a new GitHub repository from this template directly by clicking [here](https://github.com/new?template_name=nodejs-project&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

- GitHub Actions & GitHub Container Registry

## License

[MIT](LICENSE)