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
@@ -19,22 +19,23 @@ An [npm initializer][npm/init] to scaffold a node project and include basic tool
19
19
20
20
1. Install the package as global
21
21
```
22
-
npm install -g create-nodejs-project
22
+
npm install -g create-NodeJS-project
23
23
```
24
24
25
-
2. Config your github information
26
-
See [Github Auth](#configure-github-authentication)
25
+
2. You will be prompted for your Github information
26
+
If you do not have the information at the moment, you can keep it empty.
27
+
In order to create projects with Github integration, you will need to add the authentication information later. See [Github Auth](#configure-Github-authentication)
27
28
28
29
3. Create your project
29
30
```
30
-
npm init nodejs-project path/to/new/project
31
+
npm init NodeJS-project path/to/new/project
31
32
```
32
33
33
34
## What it does
34
35
35
36
1. Create the folder for the new project
36
37
1. Guide you through a questionnarie to setup the project
37
-
2. Initialize a git repo
38
+
2. Initialize a git repository
38
39
3. Copy the template files (src, eslintrc, gitignore, readme, etc)
39
40
4. Can create a Github repository
40
41
5. Handle the Github tokens for multiple accounts/users
@@ -55,23 +56,21 @@ So, the idea is to have a create package to use it in the form of:
55
56
56
57
and with this have a new folder my-new-project with everything ready to work.
57
58
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.
59
+
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.
59
60
60
61
## Future features
61
62
62
-
1. Fix the structure of modules, classes and etc
63
-
4. Unit testing
63
+
1. Unit testing
64
64
7. Options to create the project with params instead of questionnaire
65
65
10. A good error handler
66
66
11. Color for the console messages
67
67
12. Improve the template structure (the one that is generated in the new project) to include unit test
68
68
13. Include license files to the template copy/update process
69
-
14. A logger ? (just for learning)
70
69
18. Option to questionnaire with all the default values
71
70
72
71
## Configure Github Authentication
73
72
74
-
If you are planning to allow this script to create your github repositories, is required to generate a Github Token.
73
+
If you are planning to allow this script to create your Github repositories, is required to generate a Github Token.
75
74
76
75
1. Visit https://github.com/settings/tokens.
77
76
2. Click Generate new token.
@@ -87,13 +86,13 @@ If you are planning to allow this script to create your github repositories, is
87
86
```
88
87
3. Click Generate token.
89
88
4. Copy the generated string to a safe place, such as a password safe.
90
-
5. Open Terminal and add the github token. Note: The file may be empty, you can use `auth-example.json` to copy and paste.
89
+
5. Open Terminal and add the Github token.
91
90
92
91
```
93
92
# nano ~/auth.json
94
93
95
94
{
96
-
"github": [
95
+
"Github": [
97
96
{
98
97
"user": "YOUR_USER",
99
98
"token": "YOUR_TOKEN"
@@ -109,7 +108,7 @@ If you are planning to allow this script to create your github repositories, is
0 commit comments