feat(structure): changes the structure of the repo, modifying config …

…files and enabling semantic release

BREAKING CHANGE:

.env.example

@@ -0,0 +1,5 @@
+TSC_COMPILE_ON_ERROR=true
+ESLINT_NO_DEV_ERRORS=true
+CHOKIDAR_USEPOLLING=true
+NODE_ENV=development
+SERVER_PORT=8000

.eslintrc.js

@@ -0,0 +1,25 @@
+module.exports = {
+    "env": {
+        "browser": true,
+        "es2021": true
+    },
+    "extends": [
+        "eslint:recommended",
+        "plugin:react/recommended",
+        "plugin:@typescript-eslint/recommended"
+    ],
+    "parser": "@typescript-eslint/parser",
+    "parserOptions": {
+        "ecmaFeatures": {
+            "jsx": true
+        },
+        "ecmaVersion": 13,
+        "sourceType": "module"
+    },
+    "plugins": [
+        "react",
+        "@typescript-eslint"
+    ],
+    "rules": {
+    }
+};

.github/FUNDING.yml

@@ -0,0 +1 @@
+github: [blackboardd]

.github/ISSUE_TEMPLATE/1.bug.md

@@ -0,0 +1,19 @@
+---
+name: Bug report
+about: Create a bug report.
+labels: 'status: needs triage'
+---
+
+# What happens
+
+## What should happen
+
+## How to reproduce
+
+Steps:
+
+1.
+2.
+3.
+
+## Your environment

.github/ISSUE_TEMPLATE/2.feature.md

@@ -0,0 +1,11 @@
+---
+name: Feature request
+about: Suggest a new idea.
+labels: 'status: needs triage'
+---
+
+# Summary
+
+## Examples
+
+## Why

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
+blank_issues_enabled: false

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,7 @@
+Fixes #
+
+Summary: Put summary here
+
+- [ ] followed style guidelines
+- [ ] Reviewed my code
+- [ ] Commented my code

.github/renovate.json

@@ -0,0 +1,12 @@
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "automerge": false,
+  "commitMessageAction": "Bump",
+  "commitMessageExtra": "to {{newValue}}",
+  "commitMessageTopic": "{{depName}}",
+  "dependencyDashboard": true,
+  "rebaseWhen": "conflicted",
+  "ignoreDeps": [],
+  "labels": ["dependencies"],
+  "timezone": "UTC"
+}

.ghscripts/update_icons.ps1 → .github/scripts/update_icons.ps1

@@ -1,4 +1,4 @@
-Push-Location ../.ghimages/icons
+Push-Location ../images/icons
 $dirs = Get-ChildItem | ForEach-Object $_ { $_.Name }
 
 $dirs | ForEach-Object $_ {

.github/workflows/release.yml

@@ -0,0 +1,25 @@
+name: Release
+on:
+  push:
+    branches:
+      - main
+jobs:
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - name: Setup Node.js
+        uses: actions/setup-node@v2
+        with:
+          node-version: 'lts/*'
+      - name: Install dependencies
+        run: yarn install --frozen-lockfile
+      - name: Release
+        env:
+          GH_TOKEN: ${{ secrets.GH_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: npx dotenv semantic-release

.gitignore

@@ -1,11 +1,14 @@
+# node modules
 node_modules
-.DS_Store
+
+# build
 dist
-dist-ssr
-*.local
-yarn.lock
-package.lock
+
+# log files
 *.log
-storybook-static
-.history
-client/src/style-dictionary-dist/
+
+# environment
+.env
+
+# style dictionary build
+src/style-dictionary-dist

.husky/.pre-commit

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npx pretty-quick --staged

.releaserc

@@ -0,0 +1,54 @@
+{
+  "branches": [
+    "+([0-9])?(.{+([0-9]),x}).x",
+    "main",
+    "next",
+    "next-major",
+    {"name": "beta", "prerelease": true},
+    {"name": "alpha", "prerelease": true}
+  ],
+  "plugins": [
+  ["@semantic-release/commit-analyzer", {
+      "preset": "angular",
+      "parserOpts": {
+        "noteKeywords": ["BREAKING CHANGE", "BREAKING CHANGES", "BREAKING"]
+      },
+      "releaseRules": [
+        {"type": "docs", "scope": "README", "release": "patch"},
+        {"type": "docs", "scope": "*template.md", "release": "patch"},
+        {"type": "refactor", "scope": "core-*", "release": "minor"},
+        {"type": "feat", "release": "minor"},
+        {"type": "fix", "release": "patch"},
+        {"type": "refactor", "release": "patch"},
+        {"type": "style", "release": "patch"},
+        {"scope": "no-release", "release": false}
+      ]
+    }],
+    ["@semantic-release/release-notes-generator", {
+      "preset": "angular",
+      "parserOpts": {
+        "noteKeywords": ["BREAKING CHANGE", "BREAKING CHANGES", "BREAKING"]
+      },
+      "writerOpts": {
+        "commitsSort": ["subject", "scope"]
+      }
+    }],
+    [
+      "@semantic-release/changelog",
+      {
+        "changelogFile": "docs/CHANGELOG.md"
+      }
+    ],
+    "@semantic-release/github",
+    ["@semantic-release/npm", {
+      "npmPublish": false
+    }],
+    [
+      "@semantic-release/git",
+      {
+      "assets": ["dist/**/*.{js,css}", "package.json", "docs/CHANGELOG.md"],
+      "message": "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
+      }
+    ]
+  ]
+}

README.md

@@ -1,6 +1,12 @@
-# Book Builder
+<h1 align="center">Book Builder</h1>
 
-![demonstration](.ghimages/gifs/demonstration.gif)
+<div align="center">
+
+[![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/blackboardd/book-builder/blob/main/LICENSE) [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/) [![Renovate status](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://github.com/blackboardd/yarn-project-template/issues/1) [![Follow on Twitter](https://img.shields.io/twitter/follow/blkboardd.svg?label=follow+blkboardd)](https://twitter.com/blkboardd)
+
+</div>
+
+![demonstration](.github/images/gifs/demonstration.gif)
 
 ## 👠 Features
 
@@ -11,54 +17,26 @@
 - ThreeJS viewer
 - glTF export
 
-## 🔧 Install
-
-[npm <img src=".ghimages/icons/npm/b0f1a8318363185cc2ea6a40ac23eeb2.png" alt="npm" height="10"/>](https://github.com/npm/cli):
-
-```shell
-# Clone repo
-$ git clone https://github.com/blackboardd/book-builder.git
-$ cd book-builder
-
-# Install dependencies
-$ npm install
-
-# Start dev server
-$ npm start
-```
-
-[yarn <img src=".ghimages/icons/yarn/icon-48x48.png" alt="yarn" height="10"/>](https://github.com/yarnpkg/yarn):
-
-```shell
-# Clone repo
-$ git clone https://github.com/blackboardd/book-builder.git
-$ cd book-builder
-
-# Install dependencies
-$ yarn install
-
-# Start dev server
-$ yarn start
-```
-
 ## 🧱 Stack
 
-- [Jest <img src=".ghimages/icons/jest/favicon.ico" alt="Jest" height="10"/>](https://github.com/facebook/jest)
-- [Lottie <img src=".ghimages/icons/lottie/favicon-32x32.png" alt="Lottie" height="10"/>](https://lottiefiles.com/)
-- [React <img src=".ghimages/icons/react/favicon-32x32.png" alt="React" height="10"/>](https://github.com/facebook/react)
-- [Recoil <img src=".ghimages/icons/recoil/favicon.png" alt="Recoil" height="10"/>](https://github.com/facebookexperimental/Recoil)
-- [Storybook <img src=".ghimages/icons/storybook/icon-storybook.png" alt="Storybook" height="10"/>](https://github.com/storybookjs/storybook)
-- [styled-components <img src=".ghimages/icons/styled-components/nav-logo.png" alt="styled-components" height="10"/>](https://github.com/styled-components/styled-components)
-- [ThreeJS <img src=".ghimages/icons/threejs/favicon.ico" alt="ThreeJS" height="10"/>](https://github.com/mrdoob/three.js/)
-- [TypeScript <img src=".ghimages/icons/typescript/favicon.ico" alt="TypeScript" height="10"/>](https://github.com/microsoft/TypeScript)
-- [Vite <img src=".ghimages/icons/vite/logo.svg" alt="Vite" height="10"/>](https://github.com/vitejs/vite)
+- [Jest <img src=".github/images/icons/jest/favicon.ico" alt="Jest" height="10"/>](https://github.com/facebook/jest)
+- [Lottie <img src=".github/images/icons/lottie/favicon-32x32.png" alt="Lottie" height="10"/>](https://lottiefiles.com/)
+- [React <img src=".github/images/icons/react/favicon-32x32.png" alt="React" height="10"/>](https://github.com/facebook/react)
+- [Recoil <img src=".github/images/icons/recoil/favicon.png" alt="Recoil" height="10"/>](https://github.com/facebookexperimental/Recoil)
+- [Storybook <img src=".github/images/icons/storybook/icon-storybook.png" alt="Storybook" height="10"/>](https://github.com/storybookjs/storybook)
+- [styled-components <img src=".github/images/icons/styled-components/nav-logo.png" alt="styled-components" height="10"/>](https://github.com/styled-components/styled-components)
+- [ThreeJS <img src=".github/images/icons/threejs/favicon.ico" alt="ThreeJS" height="10"/>](https://github.com/mrdoob/three.js/)
+- [TypeScript <img src=".github/images/icons/typescript/favicon.ico" alt="TypeScript" height="10"/>](https://github.com/microsoft/TypeScript)
+- [Vite <img src=".github/images/icons/vite/logo.svg" alt="Vite" height="10"/>](https://github.com/vitejs/vite)
+
+## Changelog
 
-### 🧑‍🤝‍🧑 Contributing
+If you have recently updated, please read the [changelog](https://github.com/blackboardd/yarn-project-template/blob/main/docs/CHANGELOG.md) for details of what has changed.
 
-To contribute to this project, make a pull request to <https://github.com/blackboardd/xps-upcharge>.
+## 🧑‍🤝‍🧑 Contributing
 
-### ⚖️ License
+Read the [contributing guide](/docs/CONTRIBUTING.md) to learn about our development process, and how to craft proposals.
 
-This project uses the [MIT license](https://opensource.org/licenses/MIT).
+## ⚖️ License
 
-Copyright (c) 2021 Brighten Clark
+This project is licensed under the terms of the [MIT license](/docs/LICENSE).