Skip to content

Commit

Permalink
Merge pull request #19 from AndyOooh/CN-1-feature-implement-commander
Browse files Browse the repository at this point in the history
Cn 1 feature implement commander
  • Loading branch information
AndyOooh authored Mar 25, 2024
2 parents 16707a8 + e605e4f commit 6d2debf
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 26 deletions.
61 changes: 36 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,34 @@
# Create-node-template

<style>
.banner {
background: radial-gradient(circle, rgba(221, 94, 77, 1) 10%, rgba(40, 41, 43, 1) 100%);
}
</style>

<div align="center" class="banner">
<img
src="https://github.com/AndyOooh/create-node-template/assets/60953822/37c52285-cbe3-43c2-a1e8-65c8f449a800"
src="https://github.com/AndyOooh/create-node-template/assets/60953822/7d340216-a4a0-4aec-af00-d724e1e9c446"
alt="React Hook Form Logo - React hook custom hook for form validation"
/>
<img
src="https://github.com/AndyOooh/create-node-template/assets/60953822/087cf649-c56e-4d4c-b686-e8819432c8f6"
/>
</div>

<!-- ![node-js-seeklogo](https://github.com/AndyOooh/create-node-template/assets/60953822/37c52285-cbe3-43c2-a1e8-65c8f449a800)
<!-- ### Description -->

![express-seeklogo](https://github.com/AndyOooh/create-node-template/assets/60953822/087cf649-c56e-4d4c-b686-e8819432c8f6) -->
A CLI template generator for Node.js projects with **modern Typescript configuration**.

## Description
### Table of Contents

This project is a template for creating a new node project. It is a CLI tool that will create a new project with the following features:
<!-- - [Description](#description) -->
- [Prerequisites](#prerequisites)
- [How to use](#how-to-use)
- [Features](#features)
- [Node Basic](#node-basic)
- [Express Basic](#express-basic)
- [Express Advanced](#express-advanced)
- [References](#references)
- [Notes](#notes)
- [Logging](#logging)
- [Monitoring (APM - app performance monitoring)](#monitoring-apm---app-performance-monitoring)

## Table of Contents

## Prerequisites
### Prerequisites

- Node.js v 16.7.0 or higher (required by experimental `fs.cp` in node-basic)

## How to use
### How to use

```
npx create-node-template <project-name> --flags
Expand All @@ -42,9 +40,22 @@ npx create-node-template <project-name> --flags

## Features

### Node Basic

- Import path aliases.
- Eslint flat config file (needs VSCode setting).
-

### Express Basic

- all features of node-basic
- Express server setup

### Express Advanced

- all features of express-basic
- Express error handling
- Express logging
- Express monitoring

## References

Expand All @@ -56,6 +67,11 @@ npx create-node-template <project-name> --flags
- Create Next App GH repo
- NPM docs

## Notes

- node-basic uses Experimental fs.cp.
- VSCode eslint setting for flat config file.

### Logging

- Morgan
Expand All @@ -68,8 +84,3 @@ npx create-node-template <project-name> --flags
- Dynatrace
- DataDog (recommended)
- Prometheus

## Notes

- node-basic uses Experimental fs.cp.
- VSCode eslint setting for flat config file.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "create-node-template",
"description": "Create node.js/express boilerplate with one command",
"author": "AndyOooh",
"version": "0.1.13",
"version": "0.1.15",
"exports": "./src/index.js",
"type": "module",
"engines": {
Expand Down

0 comments on commit 6d2debf

Please sign in to comment.