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
{{ message }}
This repository was archived by the owner on Aug 4, 2020. It is now read-only.
At the top of the file there should be a short introduction and/ or overview that explains **what** the project is. This description should match descriptions added for package managers (Gemspec, package.json, etc.)
@@ -16,7 +19,48 @@ A short description of the motivation behind the creation and maintenance of the
16
19
17
20
## Installation
18
21
19
-
Provide code examples and explanations of how to get the project.
22
+
> Provide code examples and explanations of how to get the project.
23
+
24
+
<!-- START: TRY 1 -->
25
+
26
+
Here are some base required services that are super awesome for any project as a base. There are different pricing tier for a private projects vs. a public project.
27
+
28
+
Unit tests are required at the minimum. Why? Your future self will thank you.
29
+
30
+
### Travis CI
31
+
32
+
- the quick and dirty software system that just works
33
+
- use it to run our test suite
34
+
- and use it to perform other automated duties upon test suite completion
35
+
36
+
---
37
+
38
+
- requirements (_must_):
39
+
- setup env variables: `CODECOV_TOKEN` and `GH_TOKEN`
40
+
-`CODECOV_TOKEN` is found at `/settings` url of your project on codecov.io dashboard interface. For example, here is the link to mine: `https://codecov.io/gh/csprayca/superawesomebase/settings`
41
+
-`GH_TOKEN` is generated from github. You can search for the tutorials here on github. For example, here is the link to mine: `https://github.com/settings/tokens`
42
+
- I highly recommend that you are selective in what permissions you give to what key
43
+
- For example, my keys are per project. This way if one key is compromised only one project is affected. Minimize your security risk and general penetration space.
44
+
45
+
### Coveralls
46
+
47
+
- used for visual inspection of test coverage
48
+
- backup to codecov (if it is down or fails)
49
+
- reports generated after a successful test suite
50
+
- get your own badge. For example, mine is at `https://coveralls.io/github/csprayca/superawesomeredirector?branch=master`
51
+
52
+
### Codecov
53
+
54
+
- used for visual inspection of test coverage
55
+
- backup to coveralls (if it is down or fails)
56
+
- reports generated after a successful test suite
57
+
- get your own badge from `/settings/badge`. For example, mine is: `https://codecov.io/gh/csprayca/superawesomebase/settings/badge`
58
+
59
+
### Greenkeeper
60
+
61
+
- used to keep project dependencies up to date
62
+
- bot that is run whenever a npm dependency is updated
63
+
- view dashboard with an individual status per project. For example, mine is: `https://account.greenkeeper.io/account/csprayca`
0 commit comments