Merge pull request #1 from ffmpegwasm/refactor/minor-housekeeping

Author: vinayakkulkarni

.github/dependabot.yml

@@ -0,0 +1,34 @@
+version: 2
+updates:
+  # Fetch and update latest `npm` packages
+  - package-ecosystem: npm
+    directory: '/'
+    schedule:
+      interval: daily
+      time: '00:00'
+      timezone: Asia/Calcutta
+    open-pull-requests-limit: 99
+    reviewers:
+      - vinayakkulkarni
+    assignees:
+      - vinayakkulkarni
+    commit-message:
+      prefix: fix
+      prefix-development: chore
+      include: scope
+  # Fetch and update latest `github-actions` pkgs
+  - package-ecosystem: github-actions
+    directory: '/'
+    schedule:
+      interval: daily
+      time: '00:00'
+      timezone: Asia/Calcutta
+    open-pull-requests-limit: 99
+    reviewers:
+      - vinayakkulkarni
+    assignees:
+      - vinayakkulkarni
+    commit-message:
+      prefix: fix
+      prefix-development: chore
+      include: scope

.github/semantic.yml

@@ -0,0 +1,5 @@
+# Always validate the PR title AND all the commits
+titleAndCommits: true
+# Allows use of Merge commits (eg on github: "Merge branch 'master' into feature/ride-unicorns")
+# this is only relevant when using commitsOnly: true (or titleAndCommits: true)
+allowMergeCommits: true

.github/workflows/ci.yml

@@ -4,11 +4,9 @@ on:
   push:
     branches:
       - main
-      - dev
   pull_request_target:
     branches:
       - main
-      - dev
 
 permissions:
   checks: write
@@ -25,7 +23,6 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest]
-        node: [17]
 
     steps:
       - name: Check out repository (push)
@@ -41,14 +38,11 @@ jobs:
       - name: Setup node env 🏗
         uses: actions/[email protected]
         with:
-          node-version: ${{ matrix.node }}
+          node-version-file: '.nvmrc'
           registry-url: 'https://registry.npmjs.org'
           cache: 'npm'
           check-latest: true
 
-      - name: Upgrade npm ✨
-        run: npm i -g npm@latest
-
       - name: Install dependencies 👨🏻‍💻
         run: npm ci --prefer-offline --no-audit --unsafe-perm=true
 
@@ -69,4 +63,4 @@ jobs:
           neutral_check_on_warning: true
 
       - name: Check build ⚙️
-        run: npm run build && npm run generate
+        run: npm run build

.github/workflows/lint-pr.yml

@@ -0,0 +1,17 @@
+name: 'Lint PR'
+
+on:
+  pull_request_target:
+    types:
+      - opened
+      - edited
+      - synchronize
+
+jobs:
+  main:
+    name: Validate PR title
+    runs-on: ubuntu-latest
+    steps:
+      - uses: amannn/action-semantic-pull-request@v4
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/shipjs-trigger.yml

@@ -0,0 +1,31 @@
+name: Ship js trigger
+on:
+  pull_request:
+    types:
+      - closed
+jobs:
+  build:
+    name: Release
+    runs-on: ubuntu-latest
+    if: github.event.pull_request.merged == true && startsWith(github.head_ref, 'releases/v')
+    steps:
+      - name: Checkout code 🛎
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+          ref: main
+
+      - name: Setup node environment 📦
+        uses: actions/setup-node@v3
+        with:
+          node-version-file: '.nvmrc'
+          registry-url: 'https://registry.npmjs.org'
+          cache: 'npm'
+          check-latest: true
+
+      - name: Trigger a release 🥳
+        run: npx shipjs trigger
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          SLACK_INCOMING_HOOK: ${{ secrets.SLACK_INCOMING_HOOK }}

.nvmrc

@@ -0,0 +1 @@
+17.8.0

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022-current Vinayak Kulkarni <[email protected]>
+
+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.

README.md

@@ -1,29 +1,66 @@
-# Nuxt 3 Minimal Starter
+# FFMPEG :: Nuxt 3 🕺
 
-We recommend to look at the [documentation](https://v3.nuxtjs.org).
+[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-green.svg)](https://conventionalcommits.org)
+[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/ffmpegwasm/nuxt-app/ci?logo=github-actions)](https://github.com/ffmpegwasm/nuxt-app/actions/workflows/ci.yml)
+[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/ffmpegwasm/nuxt-app/Ship%20js%20trigger?label=⛴%20Ship.js%20trigger)](https://github.com/ffmpegwasm/nuxt-app/actions/workflows/shipjs-trigger.yml)
+[![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/ffmpegwasm/nuxt-app?sort=semver&logo=github)](https://github.com/ffmpegwasm/nuxt-app/releases)
+[![Netlify Status](https://img.shields.io/netlify/cf1e046d-7a81-425a-814c-4015370e9426?logo=netlify)](https://app.netlify.com/sites/ffmpegwasm-nuxt/deploys)
+
+[![@ffmpeg/ffmpeg](https://img.shields.io/github/package-json/dependency-version/ffmpegwasm/nuxt-app/@ffmpeg/ffmpeg?logo=ffmpeg)](https://ffmpegwasm.netlify.app/)
+[![@ffmpeg/core](https://img.shields.io/github/package-json/dependency-version/ffmpegwasm/nuxt-app/dev/@ffmpeg/core?logo=ffmpeg)](https://ffmpegwasm.netlify.app/)
+[![eslint](https://img.shields.io/github/package-json/dependency-version/ffmpegwasm/nuxt-app/dev/eslint?logo=eslint)](https://eslint.org/)
+[![prettier](https://img.shields.io/github/package-json/dependency-version/ffmpegwasm/nuxt-app/dev/prettier?logo=prettier)](https://prettier.io/)
+[![nuxt](https://img.shields.io/github/package-json/dependency-version/ffmpegwasm/nuxt-app/dev/nuxt3?logo=nuxt.js)](https://v3.nuxtjs.org/)
+[![typescript](https://img.shields.io/github/package-json/dependency-version/ffmpegwasm/nuxt-app/dev/typescript?logo=TypeScript)](https://www.typescriptlang.org/)
+
+## Features
+
+- 💪 Built with [TypeScript](https://www.typescriptlang.org/).
+- 🌠 Built with the all new [Nuxt 3](https://v3.nuxtjs.org/)
 
 ## Setup
 
 Make sure to install the dependencies
 
 ```bash
-yarn install
+npm install
 ```
 
 ## Development
 
 Start the development server on http://localhost:3000
 
 ```bash
-yarn dev
+npm run dev
 ```
 
 ## Production
 
 Build the application for production:
 
 ```bash
-yarn build
+npm run build
 ```
 
-Checkout the [deployment documentation](https://v3.nuxtjs.org/docs/deployment).
+Checkout the [deployment documentation](https://v3.nuxtjs.org/docs/deployment).
+
+## Contributing
+
+1. Create your feature branch from `dev` (`git checkout -b feat/new-feature`)
+2. Commit your changes (`git commit -S -m 'feat: add feature'`)
+3. Push to the branch (`git push origin feat/new-feature`)
+4. Create a new [Pull Request](https://github.com/ffmpegwasm/nuxt-app/compare)
+
+_Note_:
+
+1. Please contribute using [GitHub Flow](https://web.archive.org/web/20191104103724/https://guides.github.com/introduction/flow/)
+2. Commits & PRs will be allowed only if the commit messages & PR titles follow the [conventional commit standard](https://www.conventionalcommits.org/), _read more about it [here](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional#type-enum)_
+3. PS. Ensure your commits are signed. _[Read why](https://withblue.ink/2020/05/17/how-and-why-to-sign-git-commits.html)_
+
+## Author
+
+**nuxt-app** &copy; [Vinayak](https://vinayakkulkarni.dev), Released under the [MIT](./LICENSE) License.<br>
+Authored and maintained by Vinayak Kulkarni with help from contributors ([list](https://github.com/ffmpegwasm/nuxt-app/graphs/contributors)).
+
+> [vinayakkulkarni.dev](https://vinayakkulkarni.dev) · GitHub [@vinayakkulkarni](https://github.com/vinayakkulkarni) · Twitter [@\_vinayak_k](https://twitter.com/_vinayak_k)
+