Initial commit

TheWilley · Dec 3, 2024 · d983bd1 · d983bd1
commit d983bd1
Show file tree

Hide file tree

Showing 25 changed files with 7,631 additions and 0 deletions.
diff --git a/.eslintrc.cjs b/.eslintrc.cjs
@@ -0,0 +1,17 @@
+module.exports = {
+  root: true,
+  env: { browser: true, es2020: true },
+  extends: [
+    'eslint:recommended',
+    'plugin:@typescript-eslint/recommended',
+    'plugin:react-hooks/recommended',
+    'prettier',
+  ],
+  ignorePatterns: ['dist', '.eslintrc.cjs'],
+  parser: '@typescript-eslint/parser',
+  plugins: ['react-refresh'],
+  rules: {
+    '@typescript-eslint/no-non-null-assertion': 'off',
+    'no-console': 1,
+  },
+};
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -0,0 +1,33 @@
+name: Tests
+
+# Controls when the action will run.
+on:
+  # Triggers the workflow on push or pull request events but only for the main branch
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+jobs:
+  build_test:
+    # The type of runner that the job will run on
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [18.x]
+
+    # Steps represent a sequence of tasks that will be executed as part of the job
+    steps:
+      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
+      - uses: actions/checkout@v2
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v2
+        with:
+          node-version: ${{ matrix.node-version }}
+      - name: npm ci, build and test
+        run: |
+          npm ci
+          npm run build --if-present
+          npm test
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,23 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+dist
+dist-ssr
+*.local
+
+# Editor directories and files
+!.vscode/extensions.json
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?
diff --git a/.husky/commit-msg b/.husky/commit-msg
@@ -0,0 +1 @@
+npx --no -- commitlint --edit $1
diff --git a/.husky/pre-commit b/.husky/pre-commit
@@ -0,0 +1 @@
+npm test
diff --git a/.prettierrc b/.prettierrc
@@ -0,0 +1,10 @@
+{
+  "semi": true,
+  "tabWidth": 2,
+  "printWidth": 90,
+  "singleQuote": true,
+  "trailingComma": "es5",
+  "jsxSingleQuote": true,
+  "bracketSpacing": true,
+  "plugins": ["prettier-plugin-tailwindcss"]
+}
diff --git a/.vscode/extensions.json b/.vscode/extensions.json
@@ -0,0 +1,3 @@
+{
+  "recommendations": ["esbenp.prettier-vscode", "dbaeumer.vscode-eslint"]
+}
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1,9 @@
+{
+  "editor.codeActionsOnSave": {
+    "source.fixAll.eslint": "always"
+  },
+  "eslint.validate": ["typescript"],
+  "editor.formatOnSave": true,
+  "prettier.configPath": ".prettierrc",
+  "editor.defaultFormatter": "esbenp.prettier-vscode"
+}
diff --git a/README.md b/README.md
@@ -0,0 +1,52 @@
+<h1 align="center">
+  <br>
+  <img src="vite-quick-start.png" alt="vite-quick-start" width="200">
+  <br>
+  vite-quick-start
+  <br>
+</h1>
+
+<h4 align="center">A minimal setup to get React working in Vite with several additional packages to make development easier.
+<br>
+<br>
+(icon by <a href="https://www.flaticon.com/authors/sympnoiaicon"> sympnoiaicon</a>)
+
+</h4>
+
+<p align="center">
+  <img src="https://github.com/TheWilley/vite-quick-start/actions/workflows/main.yml/badge.svg" alt="Tests">
+</p>
+
+<p align="center">
+  <a href="#features">Features</a> •
+  <a href="#getting-started">Getting Started</a> •
+  <a href="#license">License</a>
+</p>
+
+## Features
+
+- [React](https://reactjs.org/)
+- [vite](https://vitejs.dev/)
+- [vitest](http://vitest.dev/)
+- [eslint](https://eslint.org/)
+- [prettier](https://prettier.io/)
+- [husky](https://typicode.github.io/husky/#/)
+- [conventional-commits](https://www.conventionalcommits.org/en/v1.0.0/)
+- Automatic testing using GitHub Actions
+
+## Getting Started
+
+```
+# Install dependencies
+$ npm i
+
+# Start development server
+$ npm run dev
+
+# Build for production
+$ npm run build
+```
+
+## License
+
+By default, this project is licensed under the [MIT License](./LICENSE). You can change the license by updating the `LICENSE` file.
diff --git a/commitlint.config.js b/commitlint.config.js
@@ -0,0 +1 @@
+export default { extends: ['@commitlint/config-conventional'] };
diff --git a/index.html b/index.html
@@ -0,0 +1,13 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <link rel="icon" type="image/svg+xml" href="/vite.svg" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Vite + React + TS</title>
+  </head>
+  <body>
+    <div id="root"></div>
+    <script type="module" src="/src/main.tsx"></script>
+  </body>
+</html>
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		export default { extends: ['@commitlint/config-conventional'] };