Skip to content

Commit

Permalink
feat(init): generated by generator-node-mdl 🔥
Browse files Browse the repository at this point in the history
  • Loading branch information
sharvit committed Jul 27, 2019
0 parents commit 460ac92
Show file tree
Hide file tree
Showing 21 changed files with 8,954 additions and 0 deletions.
11 changes: 11 additions & 0 deletions .babelrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"presets": [
[
"@babel/env",
{
"targets": { "node": 8 }
}
]
],
"plugins": ["add-module-exports"]
}
6 changes: 6 additions & 0 deletions .commitlintrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"extends": [
"@commitlint/config-conventional",
"cz"
]
}
9 changes: 9 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
root = true

[*]
indent_style = space
indent_size = 2
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true
4 changes: 4 additions & 0 deletions .eslintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
coverage/
dist/
package-lock.json
package.json
23 changes: 23 additions & 0 deletions .eslintrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
{
"parser": "babel-eslint",
"extends": [
"standard",
"prettier",
"prettier/standard"
],
"plugins": [
"prettier",
"standard"
],
"env": {
"node": true,
"jest": true,
"jasmine": true
},
"rules": {
"prettier/prettier": ["error", {
"singleQuote": true,
"trailingComma": "es5"
}]
}
}
2 changes: 2 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
* text=auto
*.js text eol=lf
48 changes: 48 additions & 0 deletions .github/issue_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
<!--- Provide a general summary of the issue in the Title above -->

## I'm submitting a…

<!-- Check one of the following options with "x" -->

* [ ] Regression (a behavior that used to work and stopped working in a new release)
* [ ] Bug report <!-- Please search GitHub for a similar issue or PR before submitting -->
* [ ] Feature request
* [ ] Documentation issue or request
* [ ] Support request

## Expected Behavior

<!--- If you‘re describing a bug, tell us what should happen -->

<!--- If you‘re suggesting a change/improvement, tell us how it should work -->

## Current Behavior

<!--- If describing a bug, tell us what happens instead of the expected behavior -->

<!--- If suggesting a change/improvement, explain the difference from current behavior -->

## Possible Solution

<!--- Not obligatory, but suggest a fix/reason for the bug, -->

<!--- or ideas how to implement the addition or change -->

## Steps to Reproduce (for bugs)

<!--- Provide a link to a live example, or an unambiguous set of steps to -->

<!--- reproduce this bug. Include code or screenshot if relevant -->

1. 2. 3. 4.

## Environment

<!--- Include as many relevant details about the environment you experienced the bug in -->

* node-mdl-starter version: <!-- run `npm ls node-mdl-starter` -->
* Node version: <!-- run `node -v` -->
* NPM version: <!-- run `npm -v` -->
* Yarn version (if you use Yarn):
* Operating system: <!-- Mac, Linux, Windows -->
* Link to your project:
48 changes: 48 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
<!---
Please read the contribution guide before sending your first commit:
https://github.com/sharvit/node-mdl-starter/blob/master/contributing.md
-->

## PR Type

<!---
What types of changes does your code introduce?
Put an `x` in all the boxes that apply:
-->

* [ ] Bugfix
* [ ] Feature
* [ ] Code style update (whitespace, formatting, missing semicolons, etc.)
* [ ] Refactoring (no functional changes, no api changes)
* [ ] Build related changes
* [ ] CI related changes
* [ ] Documentation content changes
* [ ] Other… Please describe:

## Description

<!---
Describe your changes in detail
Why is this change required? What problem does it solve?
If it fixes an open issue, please link to the issue here.
-->

## How Has This Been Tested?

<!---
Please describe in detail how you tested your changes.
Include details of your testing environment, and the tests you ran to
see how your change affects other areas of the code, etc.
-->

## Screenshots (if appropriate):

## Does this PR introduce a breaking change?

<!--
If this PR contains a breaking change,
please also describe the impact and migration path for existing applications
-->

* [ ] Yes
* [ ] No
61 changes: 61 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*

# Runtime data
pids
*.pid
*.seed
*.pid.lock

# Directory for instrumented libs generated by jscoverage/JSCover
lib-cov

# Coverage directory used by tools like istanbul
coverage

# nyc test coverage
.nyc_output

# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
.grunt

# Bower dependency directory (https://bower.io/)
bower_components

# node-waf configuration
.lock-wscript

# Compiled binary addons (https://nodejs.org/api/addons.html)
build/Release

# Dependency directories
node_modules/
jspm_packages/

# Typescript v1 declaration files
typings/

# Optional npm cache directory
.npm

# Optional eslint cache
.eslintcache

# Optional REPL history
.node_repl_history

# Output of 'npm pack'
*.tgz

# Yarn Integrity file
.yarn-integrity

# dotenv environment variables file
.env

# compiled
dist
64 changes: 64 additions & 0 deletions .npmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
# Source
./src

# Test files
*test.*.*

# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*

# Runtime data
pids
*.pid
*.seed
*.pid.lock

# Directory for instrumented libs generated by jscoverage/JSCover
lib-cov

# Coverage directory used by tools like istanbul
coverage

# nyc test coverage
.nyc_output

# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
.grunt

# Bower dependency directory (https://bower.io/)
bower_components

# node-waf configuration
.lock-wscript

# Compiled binary addons (https://nodejs.org/api/addons.html)
build/Release

# Dependency directories
node_modules/
jspm_packages/

# Typescript v1 declaration files
typings/

# Optional npm cache directory
.npm

# Optional eslint cache
.eslintcache

# Optional REPL history
.node_repl_history

# Output of 'npm pack'
*.tgz

# Yarn Integrity file
.yarn-integrity

# dotenv environment variables file
.env
28 changes: 28 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
language: node_js
jobs:
include:
- stage: test
node_js: 8
script:
- yarn test
- yarn build
- node_js: 10
script:
- yarn test
- yarn build
- node_js: 12
script:
- yarn lint:commit-travis
- yarn lint
- yarn test
- yarn build
after_success: yarn coveralls
- stage: release
if: branch = master AND type = push
node_js: 12
script: yarn build
deploy:
provider: script
skip_cleanup: true
script: yarn semantic-release

78 changes: 78 additions & 0 deletions contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
# Contributing

Contributions are always welcome, no matter how large or small.

**Working on your first Pull Request?** You can learn how from this _free_ series [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github)

## Code of Conduct

By participating, you are expected to uphold this [Contributor Covenant Code of Conduct](./other/code_of_conduct.md). Please report unacceptable behavior to [sharvita@gmail.com](mailto:sharvita@gmail.com).

## Project setup

First, [fork](https://guides.github.com/activities/forking) then clone the repo:

```sh
git clone https://github.com/your-username/node-mdl-starter
cd node-mdl-starter
git remote add upstream https://github.com/sharvit/node-mdl-starter
```

Install dependencies:

```sh
yarn
```

Run test suits to validate the project is working:

```sh
yarn test
```

Run linter to validate the project code:

```sh
yarn lint
# to fix linting errors
yarn lint --fix
```


Run linter to validate your commit message:

```sh
yarn lint:commit
```


## Committing and Pushing changes

## Committing and Pushing changes

Create a branch and start hacking:

```sh
git checkout -b my-branch
```

Commit and push your changes:

`generator-node-mdl` uses [commitizen](https://github.com/commitizen/cz-cli) to create commit messages so [semantic-release](https://github.com/semantic-release/semantic-release) can automatically create releases.

```sh
git add .

yarn commit
# answer the questions

git push origin my-branch
```

Open this project on [GitHub](https://github.com/sharvit/generator-node-mdl), then click “Compare & pull request”.

## Help needed

Please checkout the [`roadmap.md`](./other/roadmap.md) and the open issues.

Also, please watch the repo and respond to questions/bug reports/feature requests, Thanks!
Loading

0 comments on commit 460ac92

Please sign in to comment.