Skip to content

Commit 133565d

Browse files
committed
🔜 Update readme and changelog with the progress
1 parent 873898d commit 133565d

File tree

2 files changed

+56
-13
lines changed

2 files changed

+56
-13
lines changed

CHANGELOG.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Changelog
2+
3+
## 0.1.4
4+
5+
* Handle the Github tokens for multiple accounts/users
6+
* Fix problem with keywords on package.json
7+
8+
## 0.1.3
9+
10+
* Create the folder for the new project
11+
* Guide you through a questionnarie to setup the project
12+
* Initialize a git repo
13+
* Copy the template files (src, eslintrc, gitignore, readme, etc)
14+
* Can create a Github repository
15+
* Install eslint dependencies
16+
* Install the selected testing dependencies
17+
* Generate package.json with all the project details
18+
* Commit and push the initial commit

README.md

Lines changed: 38 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
<img width="75px" height="75px" align="right" alt="Create NodeJS Project Logo" src="" title="Create NodeJS Project"/>
2+
13
# Node Project Initializer
24

35
[![License][license-image]][license-url] [![version][npm-image]][npm-url]
@@ -15,7 +17,18 @@ An [npm initializer][npm/init] to scaffold a node project and include basic tool
1517

1618
## Usage
1719

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+
```
1932

2033
## What it does
2134

@@ -24,35 +37,39 @@ An [npm initializer][npm/init] to scaffold a node project and include basic tool
2437
2. Initialize a git repo
2538
3. Copy the template files (src, eslintrc, gitignore, readme, etc)
2639
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
2842
5. Install the selected testing dependencies
2943
6. Generate package.json with all the project details
3044
7. Commit and push the initial commit
3145

3246
## About this package
3347

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+
3652
So, the idea is to have a create package to use it in the form of:
53+
3754
`npm init node-project path/to/project`
55+
3856
and with this have a new folder my-new-project with everything ready to work.
3957

4058
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.
4159

4260
## Future features
4361

4462
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
4866
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
5068
13. Include license files to the template copy/update process
5169
14. A logger ? (just for learning)
52-
17. Ability to handle auth for different github accounts
5370
18. Option to questionnaire with all the default values
5471

55-
## Github Auth
72+
## Configure Github Authentication
5673

5774
If you are planning to allow this script to create your github repositories, is required to generate a Github Token.
5875

@@ -76,13 +93,21 @@ If you are planning to allow this script to create your github repositories, is
7693
# nano ~/auth.json
7794
7895
{
79-
"github-oauth": {
80-
"github.com": "YOUR_TOKEN"
81-
}
96+
"github": [
97+
{
98+
"user": "YOUR_USER",
99+
"token": "YOUR_TOKEN"
100+
},
101+
{
102+
"user": "OTHER_USER",
103+
"token": "OTHER_TOKEN"
104+
}
105+
]
82106
}
83107
```
84108

85109

110+
86111
[license-url]: LICENSE
87112
[license-image]: https://img.shields.io/github/license/nmicht/create-nodejs-project.svg?style=for-the-badge&logo=appveyor
88113

0 commit comments

Comments
 (0)