Initial commit

navin-moorthy · navin-moorthy · commit 29440e642151 · 2020-12-07T13:21:37.000+05:30
diff --git a/.commitlintrc.json b/.commitlintrc.json
@@ -0,0 +1 @@
+{ "extends": ["@commitlint/config-conventional"] }
diff --git a/.eslintignore b/.eslintignore
@@ -0,0 +1,11 @@
+node_modules
+.next
+.cache
+build
+public
+dist
+coverage
+package.json
+package-lock.json
+yarn.lock
+storybook-static
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -0,0 +1,14 @@
+{
+  "plugins": ["prettier"],
+  "extends": [
+    "react-app",
+    "react-app/jest",
+    "plugin:prettier/recommended",
+    "prettier/react",
+    "prettier/flowtype",
+    "prettier/@typescript-eslint"
+  ],
+  "rules": {
+    "no-console": "off"
+  }
+}
diff --git a/.gacprc.json b/.gacprc.json
@@ -0,0 +1,6 @@
+{
+  "add": false,
+  "push": false,
+  "emoji": "emoji",
+  "editor": false
+}
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,72 @@
+# Dependency directories
+node_modules/
+jspm_packages/
+/node_modules
+/.pnp
+.pnp.js
+
+# next.js
+/.next/
+/out/
+
+# production
+/build
+
+# testing
+/coverage
+
+# dotenv environment variable files
+.env*
+
+# Mac files
+.DS_Store
+
+# Optional npm cache directory
+.npm
+
+# Yarn
+yarn-error.log
+.pnp/
+.pnp.js
+
+# Yarn Integrity file
+.yarn-integrity
+
+# Storybook build
+storybook-static
+
+# Local Netlify
+.netlify
+.idea
+*.env
+
+# Vercel folder
+.vercel
+
+# library folder
+.lib
+dist
+
+# Compiled binary addons (http://nodejs.org/api/addons.html)
+build/Release
+
+# Typescript v1 declaration files
+typings/
+
+# Optional eslint cache
+.eslintcache
+
+# Logs
+logs
+*.log
+lerna-debug.log
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+#buildsize
+size-plugin.json
+stats-react.json
+stats.html
diff --git a/.huskyrc.json b/.huskyrc.json
@@ -0,0 +1,6 @@
+{
+  "hooks": {
+    "pre-commit": "lint-staged",
+    "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
+  }
+}
diff --git a/.lintstagedrc.json b/.lintstagedrc.json
@@ -0,0 +1,8 @@
+{
+  "*.{js,ts,css,less,json,md,html,yml,yaml,pcss,jsx,tsx}": [
+    "prettier --write",
+    "git add"
+  ],
+  "package.json": ["yarn format:package"],
+  "**/*.{js,jsx,tx,tsx}": ["yarn lint"]
+}
diff --git a/.prettierignore b/.prettierignore
@@ -0,0 +1,11 @@
+.cache
+build
+node_modules
+public
+dist
+coverage
+.next
+package.json
+package-lock.json
+yarn.lock
+storybook-static
diff --git a/.prettierrc.json b/.prettierrc.json
@@ -0,0 +1,15 @@
+{
+  "arrowParens": "avoid",
+  "bracketSpacing": true,
+  "jsxBracketSameLine": false,
+  "jsxSingleQuote": false,
+  "printWidth": 80,
+  "proseWrap": "always",
+  "requirePragma": false,
+  "semi": true,
+  "singleQuote": false,
+  "tabWidth": 2,
+  "trailingComma": "all",
+  "useTabs": false,
+  "endOfLine": "auto"
+}
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1,3 @@
+{
+  "typescript.tsdk": "node_modules/typescript/lib"
+}
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Timeless
+
+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.
diff --git a/README.md b/README.md
@@ -0,0 +1,28 @@
+# React Typescript Template
+
+React Typescript Project Boilerplate
+
+## Get Started
+
+`yarn`
+
+## Eslint
+
+> Uses **Create React App** configs
+
+## Prettier
+
+> Uses in conjuction with Eslint with `eslint-plugin-prettier` &
+> `eslint-config-prettier`
+
+## Commit
+
+`git add . && yarn commit`
+
+> Uses **[gacp](https://github.com/vivaxy/gacp#readme)**
+
+- Runs [Husky](https://github.com/typicode/husky) to improve the commits.
+- Husky runs [Lint Staged](https://github.com/okonet/lint-staged) as a
+  pre-commit hook to run lintes & formatters
+- Husky lints the commit message with
+  [Commitlint](https://github.com/conventional-changelog/commitlint)
diff --git a/package.json b/package.json
@@ -0,0 +1,76 @@
+{
+  "name": "react-ts-template",
+  "version": "1.0.0",
+  "description": "React Typescript Project template",
+  "keywords": [
+    "react",
+    "template",
+    "boilerplate",
+    "typescript",
+    "new-project",
+    "new-repo"
+  ],
+  "bugs": {
+    "url": "https://github.com/timelessco/react-ts-template/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/timelessco/react-ts-template.git"
+  },
+  "license": "MIT",
+  "author": "Navin Moorthy <navin@timeless.co>",
+  "scripts": {
+    "build": "react-scripts build",
+    "commit": "gacp",
+    "eject": "react-scripts eject",
+    "format": "prettier --write \"./**/*.{js,ts,css,less,json,md,html,yml,yaml,pcss,jsx,tsx}\"",
+    "format:package": "sort-package-json",
+    "lint": "eslint src --ext .tsx,.ts,.jsx,.js",
+    "start": "react-scripts start",
+    "test": "react-scripts test"
+  },
+  "browserslist": {
+    "production": [
+      ">0.2%",
+      "not dead",
+      "not op_mini all"
+    ],
+    "development": [
+      "last 1 chrome version",
+      "last 1 firefox version",
+      "last 1 safari version"
+    ]
+  },
+  "eslintConfig": {
+    "extends": [
+      "react-app",
+      "react-app/jest"
+    ]
+  },
+  "dependencies": {
+    "react": "^17.0.1",
+    "react-dom": "^17.0.1",
+    "web-vitals": "^1.0.1"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "^11.0.0",
+    "@commitlint/config-conventional": "^11.0.0",
+    "@testing-library/dom": "^7.28.1",
+    "@testing-library/jest-dom": "^5.11.6",
+    "@testing-library/react": "^11.2.2",
+    "@testing-library/user-event": "^12.5.0",
+    "@types/jest": "^26.0.16",
+    "@types/node": "^14.14.10",
+    "@types/react": "^17.0.0",
+    "@types/react-dom": "^17.0.0",
+    "eslint-config-prettier": "^7.0.0",
+    "eslint-plugin-prettier": "^3.2.0",
+    "gacp": "^2.10.2",
+    "husky": "^4.3.0",
+    "lint-staged": "^10.5.3",
+    "prettier": "^2.2.1",
+    "react-scripts": "4.0.1",
+    "sort-package-json": "^1.48.0",
+    "typescript": "^4.1.2"
+  }
+}
diff --git a/public/favicon.ico b/public/favicon.ico
diff --git a/public/index.html b/public/index.html
@@ -0,0 +1,43 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <link rel="icon" href="%PUBLIC_URL%/favicon.ico" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <meta name="theme-color" content="#000000" />
+    <meta
+      name="description"
+      content="Web site created using create-react-app"
+    />
+    <link rel="apple-touch-icon" href="%PUBLIC_URL%/logo192.png" />
+    <!--
+      manifest.json provides metadata used when your web app is installed on a
+      user's mobile device or desktop. See https://developers.google.com/web/fundamentals/web-app-manifest/
+    -->
+    <link rel="manifest" href="%PUBLIC_URL%/manifest.json" />
+    <!--
+      Notice the use of %PUBLIC_URL% in the tags above.
+      It will be replaced with the URL of the `public` folder during the build.
+      Only files inside the `public` folder can be referenced from the HTML.
+
+      Unlike "/favicon.ico" or "favicon.ico", "%PUBLIC_URL%/favicon.ico" will
+      work correctly both with client-side routing and a non-root public URL.
+      Learn how to configure a non-root public URL by running `npm run build`.
+    -->
+    <title>React App</title>
+  </head>
+  <body>
+    <noscript>You need to enable JavaScript to run this app.</noscript>
+    <div id="root"></div>
+    <!--
+      This HTML file is a template.
+      If you open it directly in the browser, you will see an empty page.
+
+      You can add webfonts, meta tags, or analytics to this file.
+      The build step will place the bundled scripts into the <body> tag.
+
+      To begin the development, run `npm start` or `yarn start`.
+      To create a production bundle, use `npm run build` or `yarn build`.
+    -->
+  </body>
+</html>
diff --git a/public/logo192.png b/public/logo192.png
diff --git a/public/logo512.png b/public/logo512.png
diff --git a/public/manifest.json b/public/manifest.json
@@ -0,0 +1,25 @@
+{
+  "short_name": "React App",
+  "name": "Create React App Sample",
+  "icons": [
+    {
+      "src": "favicon.ico",
+      "sizes": "64x64 32x32 24x24 16x16",
+      "type": "image/x-icon"
+    },
+    {
+      "src": "logo192.png",
+      "type": "image/png",
+      "sizes": "192x192"
+    },
+    {
+      "src": "logo512.png",
+      "type": "image/png",
+      "sizes": "512x512"
+    }
+  ],
+  "start_url": ".",
+  "display": "standalone",
+  "theme_color": "#000000",
+  "background_color": "#ffffff"
+}
diff --git a/public/robots.txt b/public/robots.txt
@@ -0,0 +1,3 @@
+# https://www.robotstxt.org/robotstxt.html
+User-agent: *
+Disallow:
diff --git a/src/App.css b/src/App.css
@@ -0,0 +1,3 @@
+.App {
+  text-align: center;
+}
diff --git a/src/App.test.tsx b/src/App.test.tsx
@@ -0,0 +1,9 @@
+import React from "react";
+import { render, screen } from "@testing-library/react";
+import App from "./App";
+
+test("renders hello world", () => {
+  render(<App />);
+  const h1Element = screen.getByText(/Hello World/i);
+  expect(h1Element).toBeInTheDocument();
+});
diff --git a/src/App.tsx b/src/App.tsx
@@ -0,0 +1,12 @@
+import React from "react";
+import "./App.css";
+
+function App() {
+  return (
+    <div className="App">
+      <h1>Hello World</h1>
+    </div>
+  );
+}
+
+export default App;
diff --git a/src/index.css b/src/index.css
@@ -0,0 +1,13 @@
+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;
+}
diff --git a/src/index.tsx b/src/index.tsx
diff --git a/src/react-app-env.d.ts b/src/react-app-env.d.ts
diff --git a/src/reportWebVitals.ts b/src/reportWebVitals.ts
diff --git a/src/setupTests.ts b/src/setupTests.ts
diff --git a/tsconfig.json b/tsconfig.json
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+{ "extends": ["@commitlint/config-conventional"] }`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+{`
	`2`	`+ "typescript.tsdk": "node_modules/typescript/lib"`
	`3`	`+}`