Skip to content

Commit

Permalink
feat: first commit 🌈
Browse files Browse the repository at this point in the history
  • Loading branch information
ChoGathK committed Apr 6, 2022
0 parents commit 0992e21
Show file tree
Hide file tree
Showing 20 changed files with 14,729 additions and 0 deletions.
9 changes: 9 additions & 0 deletions .github/workflows/pr.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
name: "pr"

on:
pull_request:
branches: [master]

jobs:
check:
uses: vodyani/workflows/.github/workflows/pre-check.yml@master
23 changes: 23 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
name: "release"

on:
push:
branches: [master]

jobs:
check:
uses: vodyani/workflows/.github/workflows/pre-check.yml@master

publish_package:
needs: check
uses: vodyani/workflows/.github/workflows/publish-npm-package.yml@master
secrets:
NPM_CI_TOKEN: ${{ secrets.NPM_CI_TOKEN }}
with:
enable_build: true

publish_release:
needs: [publish_package]
uses: vodyani/workflows/.github/workflows/publish-release.yml@master
secrets:
GITHUB_CI_TOKEN: ${{ secrets.GITHUB_TOKEN }}
71 changes: 71 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*

# Build
dist
temp

# 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
report.json
eslint-report.*

# 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
.npmrc

# 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

# next.js build output
.next

# vscode
.vscode
4 changes: 4 additions & 0 deletions .husky/commit-msg
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
#!/bin/sh
. "$(dirname "$0")/_/husky.sh"

npx --no-install commitlint --edit $1
4 changes: 4 additions & 0 deletions .husky/pre-commit
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
#!/bin/sh
. "$(dirname "$0")/_/husky.sh"

npm run lint
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2022 ChoGathK

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:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

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.
29 changes: 29 additions & 0 deletions README.MD
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Vodyani swagger

*swagger*

[![Npm](https://img.shields.io/npm/v/@vodyani/swagger)](https://www.npmjs.com/package/@vodyani/swagger)
[![Npm](https://img.shields.io/npm/dm/@vodyani/swagger)](https://www.npmjs.com/package/@vodyani/swagger)
[![License](https://img.shields.io/github/license/vodyani/swagger)](LICENSE)
![Workflow](https://github.com/vodyani/swagger/actions/workflows/release.yml/badge.svg)
[![Known Vulnerabilities](https://snyk.io/test/github/vodyani/swagger/badge.svg?targetFile=package.json)](https://snyk.io/test/github/vodyani/swagger?targetFile=package.json)

## Installation

```sh
npm install @vodyani/swagger
```

## Recommendations

- typescript `v4.6.x`
- node.js `v12.x` ~ `v16.x`

## Dependencies

- [nestjs swagger](https://github.com/nestjs/swagger) `v0.26`
- [swagger-ui-express](https://github.com/scottie1984/swagger-ui-express) `v4`

## License

Vodyani swagger is [MIT licensed](LICENSE).
Loading

0 comments on commit 0992e21

Please sign in to comment.