Skip to content

Commit 72a73b8

Browse files
committed
Add project description and instructions
1 parent 71d34da commit 72a73b8

File tree

1 file changed

+67
-2
lines changed

1 file changed

+67
-2
lines changed

README.md

+67-2
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,71 @@
22

33
[![Build Status](https://travis-ci.org/vukanac/ci-base-nodejs.svg?branch=master)](https://travis-ci.org/vukanac/ci-base-nodejs)
44

5-
[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fvukanac%2Fci-base-nodejs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fvukanac%2Fci-base-nodejs?ref=badge_large)
5+
## Description
6+
7+
> CI with NodeJs and TravisCI
8+
9+
10+
This is base set of tools that help writing JavaScript code.
11+
12+
They are not obligatory but they are great help!
13+
14+
### eslint
15+
16+
Eslint will help you to write code with consistent style (quotation, indentation, unused variable, ...).
17+
18+
### flow
19+
20+
Consider using `@flow` for type checking.
21+
If file starts with `/* @flow */` it will be checked for type use consistency.
22+
It will tell if you return type that is not expected, or eg. pass parameter of
23+
string and number is expected.
24+
25+
For example check `src/index.js`.
26+
27+
28+
### The best use
29+
30+
Install plugins to Sublime Text 3:
31+
32+
* SublimeLinter
33+
* SublimeLinter-contrib-eslint
34+
* SublimeLinter-flow
35+
* ESLint-Formatter
36+
37+
Optional:
638

7-
CI with NodeJs and TravisCI
39+
* Babel
40+
* DocBlockr
41+
* FileManager
42+
* GitGutter
43+
* Pretty JSON
44+
* SUblimeLinter-annotations
45+
46+
47+
## Install
48+
49+
50+
git clone https://github.com/vukanac/ci-base-nodejs.git jsstarter
51+
cd jsstarter
52+
npm install
53+
54+
## Start dev
55+
56+
npm run flow start
57+
npm run flow status
58+
npm test
59+
60+
Watching for changes:
61+
npm run test-watch
62+
63+
64+
## Test
65+
66+
npm test
67+
68+
## License
69+
70+
MIT
71+
72+
[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fvukanac%2Fci-base-nodejs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fvukanac%2Fci-base-nodejs?ref=badge_large)

0 commit comments

Comments
 (0)