Skip to content

Commit 5529f73

Browse files
michielbdejongmichielbdejong
committed
1 parent 8942278 commit 5529f73

14 files changed

Lines changed: 8808 additions & 5 deletions

File tree

‎tasks/soukai/.eslintignore‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# don't ever lint node_modules
2+
node_modules
3+
4+
# don't lint build output (make sure it's set to your correct build folder name)
5+
lib
6+
7+
# don't lint nyc coverage output
8+
coverage

‎tasks/soukai/.eslintrc‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
{
2+
"root": true,
3+
"parser": "@typescript-eslint/parser",
4+
"plugins": ["@typescript-eslint", "jest"],
5+
"extends": [
6+
"eslint:recommended",
7+
"plugin:@typescript-eslint/recommended",
8+
"plugin:jest/recommended"
9+
]
10+
}

‎tasks/soukai/.prettierrc‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"printWidth": 120,
3+
"trailingComma": "all",
4+
"singleQuote": true
5+
}

‎tasks/soukai/LICENSE.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Copyright 2022 Hebert Cisco
2+
3+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
4+
5+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
6+
7+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

‎tasks/soukai/README.md‎

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
<p align="center">
2+
<img width="100px" src="https://raw.githubusercontent.com/hebertcisco/ts-npm-package-boilerplate/main/.github/images/favicon512x512-npm.png" align="center" alt=":package: ts-npm-package-boilerplate" />
3+
<h2 align="center">:package: ts-npm-package-boilerplate</h2>
4+
<p align="center">TypeScript NPM Module Boilerplate</p>
5+
<p align="center">
6+
<a href="https://github.com/hebertcisco/ts-npm-package-boilerplate/issues">
7+
<img alt="Issues" src="https://img.shields.io/github/issues/hebertcisco/ts-npm-package-boilerplate?style=flat&color=336791" />
8+
</a>
9+
<a href="https://github.com/hebertcisco/ts-npm-package-boilerplate/pulls">
10+
<img alt="GitHub pull requests" src="https://img.shields.io/github/issues-pr/hebertcisco/ts-npm-package-boilerplate?style=flat&color=336791" />
11+
</a>
12+
<a href="https://github.com/hebertcisco/ts-npm-package-boilerplate">
13+
<img alt="GitHub Downloads" src="https://img.shields.io/npm/dw/ts-npm-package-boilerplate?style=flat&color=336791" />
14+
</a>
15+
<a href="https://github.com/hebertcisco/ts-npm-package-boilerplate">
16+
<img alt="GitHub Total Downloads" src="https://img.shields.io/npm/dt/ts-npm-package-boilerplate?color=336791&label=Total%20downloads" />
17+
</a>
18+
<a href="https://github.com/hebertcisco/ts-npm-package-boilerplate">
19+
<img alt="GitHub release" src="https://img.shields.io/github/release/hebertcisco/ts-npm-package-boilerplate.svg?style=flat&color=336791" />
20+
</a>
21+
<br />
22+
<br />
23+
<a href="https://github.com/hebertcisco/ts-npm-package-boilerplate/issues/new/choose">Report Bug</a>
24+
<a href="https://github.com/hebertcisco/ts-npm-package-boilerplate/issues/new/choose">Request Feature</a>
25+
</p>
26+
<h3 align="center">Systems on which it has been tested:</h3>
27+
<p align="center">
28+
<a href="https://www.apple.com/br/macos/">
29+
<img alt="Macos" src="https://img.shields.io/badge/mac%20os-000000?style=for-the-badge&logo=apple&logoColor=white&style=flat" />
30+
</a>
31+
<a href="https://ubuntu.com/download">
32+
<img alt="Ubuntu" src="https://img.shields.io/badge/Ubuntu-E95420?style=for-the-badge&logo=ubuntu&logoColor=white&style=flat" />
33+
</a>
34+
<a href="https://www.microsoft.com/pt-br/windows/">
35+
<img alt="Windows" src="https://img.shields.io/badge/Windows-0078D6?style=for-the-badge&logo=windows&logoColor=white&style=flat" />
36+
</a>
37+
</p>
38+
<p align="center">Did you like the project? Please, considerate <a href="https://www.buymeacoffee.com/hebertcisco">a donation</a> to help improve!</p>
39+
40+
<p align="center"><strong>TypeScript NPM Module Boilerplate</strong>✨</p>
41+
42+
[![codecov](https://codecov.io/gh/hebertcisco/ts-npm-package-boilerplate/branch/main/graph/badge.svg?token=Q9fr548J0D)](https://codecov.io/gh/hebertcisco/ts-npm-package-boilerplate)
43+
44+
# Getting started
45+
46+
## Installation
47+
48+
> Clone this repository: `git clone https://github.com/hebertcisco/ts-npm-package-boilerplate`
49+
50+
### Open the directory and run the script line:
51+
52+
```bash
53+
cd ts-npm-package-boilerplate
54+
```
55+
```bash
56+
npm i # or yarn
57+
```
58+
```bash
59+
rm -rf .git && git init && git add . && git commit -m "Initial commit" #Optional
60+
```
61+
Or create use the button "Use this template"
62+
63+
Edit the Icon on Figma:
64+
65+
<a href="https://www.figma.com/file/vpevGX3j9tmtW8OyLQ9eUm/ts-npm-package-boilerplate-icon?node-id=0%3A1">
66+
<img alt="Figma Icon" src="https://raw.githubusercontent.com/hebertcisco/ts-npm-package-boilerplate/main/.github/images/figma-badge.png"/>
67+
</a>
68+
69+
## 🤝 Contributing
70+
71+
Contributions, issues and feature requests are welcome!<br />Feel free to check [issues page](issues).
72+
73+
## Show your support
74+
75+
Give a ⭐️ if this project helped you!
76+
77+
Or buy me a coffee 🙌🏾
78+
79+
<a href="https://www.buymeacoffee.com/hebertcisco">
80+
<img src="https://img.buymeacoffee.com/button-api/?text=Buy me a coffee&emoji=&slug=hebertcisco&button_colour=FFDD00&font_colour=000000&font_family=Inter&outline_colour=000000&coffee_colour=ffffff" />
81+
</a>
82+
83+
## 📝 License
84+
85+
Copyright © 2022 [Hebert F Barros](https://github.com/hebertcisco).<br />
86+
This project is [MIT](LICENSE) licensed.

‎tasks/soukai/SECURITY.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Security Policy
2+
3+
## Supported Versions
4+
5+
Use this section to tell people about which versions of your project are
6+
currently being supported with security updates.
7+
8+
| Version | Supported |
9+
| ------- | ------------------ |
10+
| 5.1.x | :white_check_mark: |
11+
| 5.0.x | :x: |
12+
| 4.0.x | :white_check_mark: |
13+
| < 4.0 | :x: |
14+
15+
## Reporting a Vulnerability
16+
17+
Use this section to tell people how to report a vulnerability.
18+
19+
Tell them where to go, how often they can expect to get an update on a
20+
reported vulnerability, what to expect if the vulnerability is accepted or
21+
declined, etc.

‎tasks/soukai/jest.config.js‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
module.exports = {
2+
transform: {
3+
'^.+\\.(t|j)s$': 'ts-jest',
4+
},
5+
testRegex: '(/__tests__/.*|(\\.|/)(test|spec))\\.(t|j)s$',
6+
moduleFileExtensions: ['ts', 'js', 'json', 'node'],
7+
};

0 commit comments

Comments
 (0)