You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -15,7 +17,18 @@ An [npm initializer][npm/init] to scaffold a node project and include basic tool
15
17
16
18
## Usage
17
19
18
-
`npm init node-project path/to/project`
20
+
1. Install the package as global
21
+
```
22
+
npm install -g create-nodejs-project
23
+
```
24
+
25
+
2. Config your github information
26
+
See [Github Auth](#configure-github-authentication)
27
+
28
+
3. Create your project
29
+
```
30
+
npm init nodejs-project path/to/new/project
31
+
```
19
32
20
33
## What it does
21
34
@@ -24,35 +37,39 @@ An [npm initializer][npm/init] to scaffold a node project and include basic tool
24
37
2. Initialize a git repo
25
38
3. Copy the template files (src, eslintrc, gitignore, readme, etc)
26
39
4. Can create a Github repository
27
-
5. Install eslint
40
+
5. Handle the Github tokens for multiple accounts/users
41
+
5. Install eslint dependencies
28
42
5. Install the selected testing dependencies
29
43
6. Generate package.json with all the project details
30
44
7. Commit and push the initial commit
31
45
32
46
## About this package
33
47
34
-
So, this started as a dry thing.
35
-
I'm not expert with NodeJS, but every time that I start a new project, I hate to go to other project, copy files like eslintrc, editorconfig, install the same dependencies, create folder structure, etc.
48
+
So, this started as a dry thing.
49
+
50
+
I'm not expert with NodeJS, but every time that I start a new project, I hate to go to other project, copy files like eslintrc, editorconfig, install the same dependencies, create folder structure, etc.
51
+
36
52
So, the idea is to have a create package to use it in the form of:
53
+
37
54
`npm init node-project path/to/project`
55
+
38
56
and with this have a new folder my-new-project with everything ready to work.
39
57
40
58
I know there are a lot of similar packages out there, but the idea is to learn more about nodejs api, handling files, packages, etc.
41
59
42
60
## Future features
43
61
44
62
1. Fix the structure of modules, classes and etc
45
-
4.Add unit testing
46
-
7.Add options to create the project with params instead of questionnaire
47
-
10.Add a good error handler
63
+
4.Unit testing
64
+
7.Options to create the project with params instead of questionnaire
65
+
10.A good error handler
48
66
11. Color for the console messages
49
-
12.Modify template structure (the one that is generated in the new project) to include unit test
67
+
12.Improve the template structure (the one that is generated in the new project) to include unit test
50
68
13. Include license files to the template copy/update process
51
69
14. A logger ? (just for learning)
52
-
17. Ability to handle auth for different github accounts
53
70
18. Option to questionnaire with all the default values
54
71
55
-
## Github Auth
72
+
## Configure Github Authentication
56
73
57
74
If you are planning to allow this script to create your github repositories, is required to generate a Github Token.
58
75
@@ -76,13 +93,21 @@ If you are planning to allow this script to create your github repositories, is
0 commit comments