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
Copy file name to clipboardExpand all lines: README.md
+44-1Lines changed: 44 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,10 +22,53 @@ The starter also provides you all the setup for quickly pushing new versions to
22
22
23
23
### Dev utilities
24
24
-[Prettier](https://prettier.io/) - Code formater
25
-
-[Husky](https://github.com/typicode/husky) and [Lint-staged](https://github.com/okonet/lint-staged) to run prettier on each commit on staged files.
25
+
-[Commitizen](https://github.com/commitizen/cz-cli) Util that helps to create conventional commit messages
26
+
-[Commitlint](https://github.com/conventional-changelog/commitlint) Lint your commit messages to ensure you use conventional commits
27
+
-[Husky](https://github.com/typicode/husky) and [Lint-staged](https://github.com/okonet/lint-staged) to run prettier on each commit on staged files. Husky is also used to run commitlint on a commit.
26
28
27
29
### Build tools
28
30
-[Codecov](https://codecov.io/) - Integration to upload your coverage report to codecov
29
31
-[Travis](https://travis-ci.org/) - Sample travis file with all the necessary build steps
30
32
-[SemanticRelease](https://github.com/semantic-release/semantic-release) - All the setup to use semantic release. Publish your command line utility to npm by using conventional commits
31
33
34
+
## Folder structure
35
+
36
+
|__**__mocks__** Folder that contains the mocks for third party libraries
37
+
38
+
|__**bin** contains your file with the commander instructions - this is the entry to your command line tool
39
+
40
+
|__**src** contains your implementation and the logic - is called by the file in your bin folder
41
+
42
+
## Getting started
43
+
44
+
### Development
45
+
1. Fork this repo
46
+
2. Adjust the URLs and names in package.json
47
+
3. Adjust the files in bin, src and __mocks__
48
+
4. Adjust the bin command in package.json
49
+
50
+
### Setup CI (Travis)
51
+
1. Go to https://travis-ci.org/ and sign up with your Github account. Accept the Authorizaiton of GitHub. Activate Travis for your repository.
52
+
2. The starter allready contains a .travis.yml file that will be interpreted up by travis.
53
+
54
+
### Setup npm account
55
+
Sign up on https://www.npmjs.com/.
56
+
57
+
### Setup using semantic-release-cli
58
+
```
59
+
npm install -g semantic-release-cli
60
+
61
+
cd your-module
62
+
semantic-release-cli setup
63
+
```
64
+
Enter the required informations. The CLI will do the setup and add the necessary tokens to your Travie repository settings.
65
+
66
+
### Visualize coverage
67
+
To visualize coverage just sign up on https://codecov.io/.
68
+
Go to Settings and copy the token. Add this token as CODECOV_TOKEN to your travis repository settings.
0 commit comments