1
Fork 0

Initial commit

This commit is contained in:
Tobias Berger 2022-01-07 12:09:22 +01:00
commit 81caeee2cc
19 changed files with 3702 additions and 0 deletions

2
.eslintignore Normal file
View file

@ -0,0 +1,2 @@
node_modules/
.next/

45
.eslintrc.json Normal file
View file

@ -0,0 +1,45 @@
{
"root": true,
"parser": "@typescript-eslint/parser",
"parserOptions": {
"ecmaVersion": 2020,
"sourceType": "module",
"ecmaFeatures": {
"jsx": true
}
},
"settings": {
"react": {
"version": "detect"
}
},
"env": {
"browser": true,
"amd": true,
"node": true
},
"extends": [
"eslint:recommended",
"plugin:react/recommended",
"plugin:@typescript-eslint/recommended",
"plugin:@next/next/recommended",
"plugin:jsx-a11y/recommended",
"plugin:prettier/recommended",
"next",
"next/core-web-vitals"
],
"plugins": ["import", "simple-import-sort", "prettier"],
"rules": {
"prettier/prettier": ["error", {}, { "usePrettierrc": true }],
"react/react-in-jsx-scope": "off",
"jsx-a11y/accessible-emoji": "off",
"@typescript-eslint/explicit-function-return-type": "off",
"@typescript-eslint/no-unused-vars": [
"error",
{ "argsIgnorePattern": "^_.+" }
],
"simple-import-sort/imports": "error",
"simple-import-sort/exports": "error",
"no-duplicate-imports": "off"
}
}

18
.github/workflows/yarn-test.yaml vendored Normal file
View file

@ -0,0 +1,18 @@
name: Check Code Quality
on:
push:
branches:
- main
pull_request:
branches:
- main
workflow_dispatch:
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Install package
run: yarn install
- name: Run `test` script
run: yarn test

2
.gitignore vendored Normal file
View file

@ -0,0 +1,2 @@
.next/
node_modules/

2
.prettierignore Normal file
View file

@ -0,0 +1,2 @@
node_modules/
.next/

3
.prettierrc Normal file
View file

@ -0,0 +1,3 @@
{
"endOfLine": "lf"
}

16
README.md Normal file
View file

@ -0,0 +1,16 @@
# Next + Preact + Typescript + Eslint + Prettier
A starter for Preact with Typescript with the fast Vite and all static code testing with Eslint and formatting with Prettier.
![Vite + Preact + Typescript + Eslint + Prettier](/resources/screenshot.png)
A template based on the following technologies: [Next](https://github.com/vercel/next.js), [Preact](https://preactjs.com/), [Typescript](https://www.typescriptlang.org/), [Eslint](https://eslint.org/), [Prettier](https://prettier.io/).
Modified from [this template](https://github.com/TheSwordBreaker/vite-reactts-eslint-prettier)
## Installation
Clone the repo and run `yarn install`
## Start
After the successfull installation of the packages: `yarn start`

13
index.html Normal file
View file

@ -0,0 +1,13 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<link rel="icon" type="image/svg+xml" href="src/favicon.svg" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Vite App</title>
</head>
<body preact-app>
<div id="root"></div>
<script type="module" src="/@vit-app"></script>
</body>
</html>

3
next-env.d.ts vendored Normal file
View file

@ -0,0 +1,3 @@
/// <reference types="next" />
/// <reference types="next/types/global" />
/// <reference types="next/image-types/global" />

15
next.config.js Normal file
View file

@ -0,0 +1,15 @@
module.exports = {
eslint: {
ignoreDuringBuilds: true,
},
webpack(config, { dev }) {
if (!dev) {
Object.assign(config.resolve.alias, {
react: "preact/compat",
"react-dom": "preact/compat",
"react-dom/test-utils": "preact/test-utils",
});
}
return config;
},
};

45
package.json Normal file
View file

@ -0,0 +1,45 @@
{
"name": "vite-preact-ts-eslint-prettier",
"version": "0.0.0",
"scripts": {
"dev": "next dev",
"build": "next build",
"start": "next start",
"prod": "yarn build && yarn start",
"type-check": "tsc",
"lint:eslint": "eslint **/*.{ts,tsx}",
"lint:prettier": "prettier . --check",
"lint": "yarn lint:eslint && yarn lint:prettier",
"fix:eslint": "yarn lint:eslint --fix",
"fix:prettier": "prettier . --write",
"fix": "yarn fix:eslint && yarn fix:prettier",
"test:eslint": "yarn lint:eslint --max-warnings=0",
"test:prettier": "yarn lint:prettier",
"test": "yarn type-check && yarn test:eslint && yarn test:prettier"
},
"dependencies": {
"@types/react": "^17.0.13",
"next": "^11.0.1",
"preact": "^10.5.14",
"typescript": "^4.3.5"
},
"devDependencies": {
"@types/react-dom": "^17.0.8",
"@typescript-eslint/eslint-plugin": "^4.28.0",
"@typescript-eslint/parser": "^4.28.0",
"eslint": "^7.29.0",
"eslint-config-next": "^11.0.1",
"eslint-config-prettier": "^8.3.0",
"eslint-plugin-import": "^2.23.4",
"eslint-plugin-jsx-a11y": "^6.4.1",
"eslint-plugin-prettier": "^3.4.0",
"eslint-plugin-react": "^7.24.0",
"eslint-plugin-simple-import-sort": "^7.0.0",
"pre-commit": "^1.2.2",
"prettier": "^2.3.2",
"react": "^17.0.2",
"react-dom": "^17.0.2"
},
"pre-commit": "test",
"license": "MIT"
}

3
src/pages/404.tsx Normal file
View file

@ -0,0 +1,3 @@
export default function NotFound(): JSX.Element {
return <>404</>;
}

3
src/pages/_app.tsx Normal file
View file

@ -0,0 +1,3 @@
import "./styles.css";
export { default } from "next/app";

56
src/pages/index.tsx Normal file
View file

@ -0,0 +1,56 @@
import Image from "next/image";
import { useState } from "react";
export default function Index(): JSX.Element {
const [count, setCount] = useState(0);
return (
<>
<header className="app-header">
{" "}
<Image
src={require("../util/logo.svg")}
className="logo"
alt="logo"
width={350}
height={265}
/>
<p className="header">
Next.js + Preact + Typescript <br />
& <br />
Eslint + Prettier
</p>
<div className="content">
<button
onClick={() => setCount(count + 1)}
style={{ cursor: "pointer" }}
>
Click me: {count}
</button>
<p>
Don&apos;t forget to install ESlint and Prettier integration in your
IDE.
</p>
<p>
<a
className="link"
href="https://preactjs.com/"
target="_blank"
rel="noopener noreferrer"
>
Learn Preact
</a>
{" | "}
<a
className="link"
href="https://nextjs.org/docs"
target="_blank"
rel="noopener noreferrer"
>
Next.js Documentation
</a>
</p>
</div>
</header>
</>
);
}

85
src/pages/styles.css Normal file
View file

@ -0,0 +1,85 @@
:root {
--primay: black;
--bg-primay: white;
--link: #2a0b0b;
text-align: center;
}
.logo {
height: 40vmin;
pointer-events: none;
}
p {
margin: 20px 0px;
}
.header {
font-size: 3rem;
}
.content {
margin: 20px 0 10px;
font-size: 0.9rem;
}
button {
outline: none;
border: none;
border-radius: 8px;
padding: 10px 35px;
background: #845ec2;
color: white;
}
@media (prefers-reduced-motion: no-preference) {
.logo {
animation: logo-spin infinite 20s linear;
}
}
.app-header {
background-color: #282c34;
min-height: 100vh;
display: flex;
flex-direction: column;
align-items: center;
justify-content: center;
font-size: calc(10px + 2vmin);
background: var(--bg-primay);
color: var(--primay);
}
.link {
color: var(--link);
}
@keyframes logo-spin {
from {
transform: rotate(0deg);
}
to {
transform: rotate(360deg);
}
}
button {
font-size: calc(10px + 2vmin);
}
body {
margin: 0;
font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", "Roboto", "Oxygen",
"Ubuntu", "Cantarell", "Fira Sans", "Droid Sans", "Helvetica Neue",
sans-serif;
-webkit-font-smoothing: antialiased;
-moz-osx-font-smoothing: grayscale;
}
code {
font-family: source-code-pro, Menlo, Monaco, Consolas, "Courier New",
monospace;
}

1
src/public/favicon.svg Normal file
View file

@ -0,0 +1 @@
<svg xmlns="http://www.w3.org/2000/svg" width="410" height="404" fill="none" viewBox="0 0 410 404"><path fill="url(#paint0_linear)" d="M399.641 59.5246L215.643 388.545C211.844 395.338 202.084 395.378 198.228 388.618L10.5817 59.5563C6.38087 52.1896 12.6802 43.2665 21.0281 44.7586L205.223 77.6824C206.398 77.8924 207.601 77.8904 208.776 77.6763L389.119 44.8058C397.439 43.2894 403.768 52.1434 399.641 59.5246Z"/><path fill="url(#paint1_linear)" d="M292.965 1.5744L156.801 28.2552C154.563 28.6937 152.906 30.5903 152.771 32.8664L144.395 174.33C144.198 177.662 147.258 180.248 150.51 179.498L188.42 170.749C191.967 169.931 195.172 173.055 194.443 176.622L183.18 231.775C182.422 235.487 185.907 238.661 189.532 237.56L212.947 230.446C216.577 229.344 220.065 232.527 219.297 236.242L201.398 322.875C200.278 328.294 207.486 331.249 210.492 326.603L212.5 323.5L323.454 102.072C325.312 98.3645 322.108 94.137 318.036 94.9228L279.014 102.454C275.347 103.161 272.227 99.746 273.262 96.1583L298.731 7.86689C299.767 4.27314 296.636 0.855181 292.965 1.5744Z"/><defs><linearGradient id="paint0_linear" x1="6" x2="235" y1="33" y2="344" gradientUnits="userSpaceOnUse"><stop stop-color="#41D1FF"/><stop offset="1" stop-color="#BD34FE"/></linearGradient><linearGradient id="paint1_linear" x1="194.651" x2="236.076" y1="8.818" y2="292.989" gradientUnits="userSpaceOnUse"><stop stop-color="#FFEA83"/><stop offset=".083" stop-color="#FFDD35"/><stop offset="1" stop-color="#FFA800"/></linearGradient></defs></svg>

After

Width:  |  Height:  |  Size: 1.5 KiB

1
src/util/logo.svg Normal file
View file

@ -0,0 +1 @@
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 841.9 595.3"><g fill="#61DAFB"><path d="M666.3 296.5c0-32.5-40.7-63.3-103.1-82.4 14.4-63.6 8-114.2-20.2-130.4-6.5-3.8-14.1-5.6-22.4-5.6v22.3c4.6 0 8.3.9 11.4 2.6 13.6 7.8 19.5 37.5 14.9 75.7-1.1 9.4-2.9 19.3-5.1 29.4-19.6-4.8-41-8.5-63.5-10.9-13.5-18.5-27.5-35.3-41.6-50 32.6-30.3 63.2-46.9 84-46.9V78c-27.5 0-63.5 19.6-99.9 53.6-36.4-33.8-72.4-53.2-99.9-53.2v22.3c20.7 0 51.4 16.5 84 46.6-14 14.7-28 31.4-41.3 49.9-22.6 2.4-44 6.1-63.6 11-2.3-10-4-19.7-5.2-29-4.7-38.2 1.1-67.9 14.6-75.8 3-1.8 6.9-2.6 11.5-2.6V78.5c-8.4 0-16 1.8-22.6 5.6-28.1 16.2-34.4 66.7-19.9 130.1-62.2 19.2-102.7 49.9-102.7 82.3 0 32.5 40.7 63.3 103.1 82.4-14.4 63.6-8 114.2 20.2 130.4 6.5 3.8 14.1 5.6 22.5 5.6 27.5 0 63.5-19.6 99.9-53.6 36.4 33.8 72.4 53.2 99.9 53.2 8.4 0 16-1.8 22.6-5.6 28.1-16.2 34.4-66.7 19.9-130.1 62-19.1 102.5-49.9 102.5-82.3zm-130.2-66.7c-3.7 12.9-8.3 26.2-13.5 39.5-4.1-8-8.4-16-13.1-24-4.6-8-9.5-15.8-14.4-23.4 14.2 2.1 27.9 4.7 41 7.9zm-45.8 106.5c-7.8 13.5-15.8 26.3-24.1 38.2-14.9 1.3-30 2-45.2 2-15.1 0-30.2-.7-45-1.9-8.3-11.9-16.4-24.6-24.2-38-7.6-13.1-14.5-26.4-20.8-39.8 6.2-13.4 13.2-26.8 20.7-39.9 7.8-13.5 15.8-26.3 24.1-38.2 14.9-1.3 30-2 45.2-2 15.1 0 30.2.7 45 1.9 8.3 11.9 16.4 24.6 24.2 38 7.6 13.1 14.5 26.4 20.8 39.8-6.3 13.4-13.2 26.8-20.7 39.9zm32.3-13c5.4 13.4 10 26.8 13.8 39.8-13.1 3.2-26.9 5.9-41.2 8 4.9-7.7 9.8-15.6 14.4-23.7 4.6-8 8.9-16.1 13-24.1zM421.2 430c-9.3-9.6-18.6-20.3-27.8-32 9 .4 18.2.7 27.5.7 9.4 0 18.7-.2 27.8-.7-9 11.7-18.3 22.4-27.5 32zm-74.4-58.9c-14.2-2.1-27.9-4.7-41-7.9 3.7-12.9 8.3-26.2 13.5-39.5 4.1 8 8.4 16 13.1 24 4.7 8 9.5 15.8 14.4 23.4zM420.7 163c9.3 9.6 18.6 20.3 27.8 32-9-.4-18.2-.7-27.5-.7-9.4 0-18.7.2-27.8.7 9-11.7 18.3-22.4 27.5-32zm-74 58.9c-4.9 7.7-9.8 15.6-14.4 23.7-4.6 8-8.9 16-13 24-5.4-13.4-10-26.8-13.8-39.8 13.1-3.1 26.9-5.8 41.2-7.9zm-90.5 125.2c-35.4-15.1-58.3-34.9-58.3-50.6 0-15.7 22.9-35.6 58.3-50.6 8.6-3.7 18-7 27.7-10.1 5.7 19.6 13.2 40 22.5 60.9-9.2 20.8-16.6 41.1-22.2 60.6-9.9-3.1-19.3-6.5-28-10.2zM310 490c-13.6-7.8-19.5-37.5-14.9-75.7 1.1-9.4 2.9-19.3 5.1-29.4 19.6 4.8 41 8.5 63.5 10.9 13.5 18.5 27.5 35.3 41.6 50-32.6 30.3-63.2 46.9-84 46.9-4.5-.1-8.3-1-11.3-2.7zm237.2-76.2c4.7 38.2-1.1 67.9-14.6 75.8-3 1.8-6.9 2.6-11.5 2.6-20.7 0-51.4-16.5-84-46.6 14-14.7 28-31.4 41.3-49.9 22.6-2.4 44-6.1 63.6-11 2.3 10.1 4.1 19.8 5.2 29.1zm38.5-66.7c-8.6 3.7-18 7-27.7 10.1-5.7-19.6-13.2-40-22.5-60.9 9.2-20.8 16.6-41.1 22.2-60.6 9.9 3.1 19.3 6.5 28.1 10.2 35.4 15.1 58.3 34.9 58.3 50.6-.1 15.7-23 35.6-58.4 50.6zM320.8 78.4z"/><circle cx="420.9" cy="296.5" r="45.7"/><path d="M520.5 78.1z"/></g></svg>

After

Width:  |  Height:  |  Size: 2.6 KiB

21
tsconfig.json Normal file
View file

@ -0,0 +1,21 @@
{
"compilerOptions": {
"baseUrl": ".",
"target": "ESNext",
"lib": ["DOM", "DOM.Iterable", "ESNext"],
"allowJs": false,
"skipLibCheck": true,
"esModuleInterop": true,
"allowSyntheticDefaultImports": true,
"strict": true,
"forceConsistentCasingInFileNames": true,
"module": "ESNext",
"moduleResolution": "Node",
"resolveJsonModule": true,
"isolatedModules": true,
"noEmit": true,
"jsx": "preserve"
},
"include": ["./src"],
"exclude": ["node_modules"]
}

3368
yarn.lock Normal file

File diff suppressed because it is too large Load diff