Merge pull request #219 from KenEucker/develop

3.2.7 -- FIRST RELEASE

.github/workflows/release.yaml

@@ -0,0 +1,38 @@
+name: Release
+
+on:
+  push:
+    branches:
+      - production
+
+jobs:
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16
+      - name: Reconfigure git to use HTTP authentication
+        run: >
+          git config --global url."https://github.com/".insteadOf
+          ssh://git@github.com/
+      - name: Install dependencies
+        run: npm ci --ignore-scripts
+      - name: Run linters
+        run: npm run lint
+      - name: Build
+        run: npm run pub:build
+      - name: Expose build
+        run: npm run pub:expose
+      - name: Release
+        env:
+          GH_TOKEN: ${{ secrets.GH_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: npx semantic-release

.npmignore

@@ -0,0 +1,34 @@
+*.code-workspace
+.github
+.husky
+.vscode
+.netlify
+dist
+examples
+src
+public
+functions
+coverage
+test
+
+.env*
+
+.eslintignore
+.editorconfig
+.browserslistrc
+.eslintrc.js
+.stylelintrc.js
+.gitattributes
+.prettierignore
+.prettierrc.json
+.releaserc.json
+
+conduct.md
+contributing.md
+index.md
+tsconfig-server.json
+tsconfig.json
+tsconfig.node.json
+vite.config.ts
+publish.config.ts
+postcss.config.js

.releaserc.json

@@ -0,0 +1,6 @@
+{
+  "branches": [
+    { "name": "production" },
+    { "name": "develop", "channel": "develop", "prerelease": true }
+  ]
+}

README.md

@@ -1,5 +1,7 @@
-<h1 align="center" style="border-bottom: none;">biketag-vue</h1>
-<h3 align="center">The Official BikeTag App</h3>
+<h1 align=center>BikeTag-Vue</h1>
+<div align="center">
+<img alt="biketag-vue logo" src="https://raw.githubusercontent.com/keneucker/biketag-website/production/public/img/Tag-Logo-Stacked-V2-medium.png" height="auto" width="200" style="border-radius:25%;">
+</div>
 <p align="center">
   <a href="https://app.netlify.com/sites/biketag/deploys">
     <img alt="Netlify Status" src="https://api.netlify.com/api/v1/badges/fe7ffef3-ea39-4e5b-a5b8-3ff6f96f45e4/deploy-status">
@@ -22,9 +24,46 @@
   </a>
 </p>
 
-<div align="center">
-<img alt="biketag-vue logo" src="https://raw.githubusercontent.com/keneucker/biketag-website/production/public/img/Tag-Logo-Stacked-V2-medium.png" height="auto" width="200" style="border-radius:25%;">
-</div>
+<p align=center>The Official BikeTag component library for Vue 3.</p>
+
+## 🚀 Installation
+
+Install using your package manager of choice:
+
+```bash
+npm install biketag-vue
+```
+
+## 📺 Demo
+
+https://biketag.net/component-playground
+
+## ⚙️ Usage
+
+Import the component locally or define it globally and include the css file:
+
+```vue
+<template>
+  <bike-tag />
+</template>
+
+<script lang="ts" setup>
+import { BikeTag } from 'biketag-vue';
+import 'biketag-vue/dist/style.css';
+</script>
+```
+
+## 📃 Props
+
+| Name       | Type               | Default | Description                        |
+| ---------- | ------------------ | ------- | ---------------------------------- |
+| `v-model`  | `boolean/null`     |         | Standard two way input             |
+| `disabled` | `boolean`          | false   | Makes the component uninteractable |
+| `color`    | `string`           | #3ba13b | Color of the checkbox background   |
+| `label`    | `string/undefined` |         | Checkbox label                     |
+
+
+<h3 align="center">BikeTag Vue and The Official BikeTag App</h3>
 
 <div align="center">
 

contributing.md

@@ -0,0 +1,33 @@
+# How to Contribute
+
+Thanks for taking the time to contribute!
+
+- [Code of Conduct][code of conduct]
+
+
+## Submitting Changes
+
+We use [commitizen][commitizen] to enforce [conventional commits][conventional commits]. This enables us to automate both semantic versioning and npm releases.
+
+Install the `commitizen` command line tool:
+
+```bash
+npm install -g commitizen
+```
+
+Now simply use `git cz` or just `cz` instead of `git commit` when committing.
+
+If you prefer not to install the `commitizen` command globally, alternatively you can use `npm run commit` instead of `git commit`.
+
+## Coding Conventions
+
+- Prettier is ran and applied automatically as part of a precommit hook, so you don't have to worry about semicolons or trailing commas
+
+## Inspirations
+
+This package follows the lead of the Open-Source API [biketag][biketag], with it's configurations for compiling, testing, and contributing to Javascript APIs written in TypeScript. Also, the BikeTag API utilizes the `node-imgur` package to do it's thing, with admiration.
+
+[commitizen]: https://github.com/commitizen/cz-cli
+[conventional commits]: https://www.conventionalcommits.org/
+[code of conduct]: code_of_conduct.md
+[biketag]: https://github.com/kneucker/biketag

index.html

@@ -21,7 +21,7 @@
 
   <body>
     <div id="app">
-      <script type="module" src="/src/main.ts"></script>
+      <script type="module" src="/src/app.ts"></script>
       <form name="add-found-tag" action="add-found-tag" method="POST" data-netlify="true"
         data-netlify-honeypot="bot-field" hidden>
         <input type="hidden" name="form-name" value="add-found-tag" />