Skip to content

Commit f040b53

Browse files
committed
Initial commit
0 parents  commit f040b53

7 files changed

+6474
-0
lines changed

.editorconfig

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
[*]
2+
end_of_line = lf
3+
charset = utf-8
4+
insert_final_newline = true
5+
trim_trailing_whitespace = true
6+
indent_style = space
7+
indent_size = 2
8+
9+
[*.md]
10+
trim_trailing_whitespace = false

.eslintrc

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"extends": "airbnb-base",
3+
"rules": {
4+
"no-console": off
5+
}
6+
}

.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
node_modules/*
2+
.env

README.md

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Node Project Initializer
2+
3+
[![License][license-image]][license-url] [![version][npm-image]][npm-url]
4+
5+
An [npm initializer][npm/init] to scaffold a node project and include basic tools like lint, testing, etc.
6+
7+
## Requirements
8+
9+
- `npm >= 6.x`
10+
- `node >= 8.*`
11+
12+
## Usage
13+
14+
```bash
15+
npm init node-project [params]
16+
```
17+
18+
## How does this work?
19+
20+
> _`npm init <initializer>` can be used to set up a new or existing npm package._
21+
> _`initializer` in this case is an npm package named `create-<initializer>`, which will be installed by `npx`, and then have its main bin executed -- presumably creating or updating `package.json` and running any other initialization-related operations._
22+
> _[&mdash; Source: `docs.npmjs.com`][npm/init]_
23+
24+
## Params
25+
26+
- Project path
27+
28+
`npm init node-project path/to/project`
29+
30+
Will create a new folder for the project and use the forlder name as the project name.
31+
32+
33+
34+
[license-url]: LICENSE
35+
[license-image]: https://img.shields.io/github/license/ahmadnassri/node-create.svg?style=for-the-badge&logo=circleci
36+
37+
[npm-url]: https://www.npmjs.com/package/@nmicht/create
38+
[npm-image]: https://img.shields.io/npm/v/@nmicht/create.svg?style=for-the-badge&logo=npm
39+
40+
[npm/init]: https://docs.npmjs.com/cli/init#description

0 commit comments

Comments
 (0)