chore: project setup & basics config

ashiishme · Jun 23, 2020 · c8f72d1 · c8f72d1
1 parent 1bc692c
commit c8f72d1
Show file tree

Hide file tree

Showing 22 changed files with 11,625 additions and 0 deletions.
diff --git a/package.json b/package.json
@@ -0,0 +1,53 @@
+{
+  "name": "covid-stats",
+  "version": "0.1.0",
+  "private": true,
+  "dependencies": {
+    "@testing-library/jest-dom": "^4.2.4",
+    "@testing-library/react": "^9.3.2",
+    "@testing-library/user-event": "^7.1.2",
+    "@types/jest": "^24.0.0",
+    "@types/node": "^12.0.0",
+    "@types/react": "^16.9.0",
+    "@types/react-dom": "^16.9.0",
+    "@types/styled-components": "^5.1.0",
+    "react": "^16.13.1",
+    "react-dom": "^16.13.1",
+    "react-scripts": "3.4.1",
+    "styled-components": "^5.1.1",
+    "typescript": "~3.7.2"
+  },
+  "scripts": {
+    "start": "react-scripts start",
+    "build": "react-scripts build",
+    "test": "react-scripts test",
+    "eject": "react-scripts eject",
+    "precommit": "lint-staged"
+  },
+  "lint-staged": {
+    "src/**/*.{tsx,ts,json,scss}": [
+      "prettier --write",
+      "git add"
+    ]
+  },
+  "eslintConfig": {
+    "extends": "react-app"
+  },
+  "browserslist": {
+    "production": [
+      ">0.2%",
+      "not dead",
+      "not op_mini all"
+    ],
+    "development": [
+      "last 1 chrome version",
+      "last 1 firefox version",
+      "last 1 safari version"
+    ]
+  },
+  "devDependencies": {
+    "husky": "^4.2.5",
+    "lint-staged": "^10.2.10",
+    "prettier": "^2.0.5"
+  }
+}
diff --git a/public/favicon.ico b/public/favicon.ico
diff --git a/public/index.html b/public/index.html
@@ -0,0 +1,17 @@
+<!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="COVID-19 Stats Chrome Extension" />
+        <link rel="apple-touch-icon" href="%PUBLIC_URL%/logo192.png" />
+        <link rel="manifest" href="%PUBLIC_URL%/manifest.json" />
+        <title>COVID-19 Stats</title>
+    </head>
+    <body>
+        <noscript>You need to enable JavaScript to run this app.</noscript>
+        <div id="root"></div>
+    </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,17 @@
+{
+  "manifest_version": 2,
+  "short_name": "COVID-19 Stats",
+  "name": "COVID-19 Stats Chrome Extension",
+  "version": "0.1.0",
+  "description": "COVID-19 Stats: A chrome extension to show the latest COVID-19 updates.",
+  "browser_action": {
+    "default_popup": "index.html"
+  },
+  "content_scripts": [],
+  "web_accessible_resources": ["js/*", "html/*", "css/*"],
+  "icons": {
+    "16": "favicon.ico",
+    "192": "logo192.png",
+    "512": "logo512.png"
+  }
+}
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/public/services/background.ts b/public/services/background.ts
diff --git a/src/@types/styles/theme.d.ts b/src/@types/styles/theme.d.ts
@@ -0,0 +1,9 @@
+import 'styled-components';
+import { theme } from '../../styles';
+
+type Theme = typeof theme;
+declare module 'styled-components' {
+    export interface DefaultTheme extends Theme {
+        // Type Inference in action
+    }
+}
diff --git a/src/app/components/popup/dashboard/dashboard.tsx b/src/app/components/popup/dashboard/dashboard.tsx
@@ -0,0 +1,9 @@
+import React, { FC } from 'react';
+
+const Dashboard: FC = () => (
+  <div className='ashiishme-covid-dashboard'>
+    <p>Dashboard</p>
+  </div>
+);
+
+export default Dashboard;
diff --git a/src/app/components/popup/index.ts b/src/app/components/popup/index.ts
@@ -0,0 +1,2 @@
+export { default as Dashboard } from './dashboard/dashboard';
+export { default as Settings } from './settings/settings';
diff --git a/src/app/components/popup/settings/settings.tsx b/src/app/components/popup/settings/settings.tsx
@@ -0,0 +1,9 @@
+import React, { FC } from 'react';
+
+const Settings: FC = () => (
+  <div className='ashiishme-covid-settings'>
+    <p>Settings</p>
+  </div>
+);
+
+export default Settings;
diff --git a/src/app/index.tsx b/src/app/index.tsx
@@ -0,0 +1,12 @@
+import React, { FC } from 'react';
+
+import { Dashboard, Settings } from './components/popup';
+import { Container } from '../styles';
+const App: FC = () => (
+    <Container className="ashiishme_covid_container">
+        <Dashboard />
+        <Settings />
+    </Container>
+);
+
+export default App;
diff --git a/src/index.tsx b/src/index.tsx
@@ -0,0 +1,20 @@
+import React from 'react';
+import ReactDOM from 'react-dom';
+import App from './app';
+import { ThemeProvider } from 'styled-components';
+import { theme, GlobalStyles } from './styles';
+import * as serviceWorker from './serviceWorker';
+ReactDOM.render(
+    <React.StrictMode>
+        <ThemeProvider theme={theme}>
+            <GlobalStyles />
+            <App />
+        </ThemeProvider>
+    </React.StrictMode>,
+    document.getElementById('root')
+);
+
+// If you want your app to work offline and load faster, you can change
+// unregister() to register() below. Note this comes with some pitfalls.
+// Learn more about service workers: https://bit.ly/CRA-PWA
+serviceWorker.unregister();
diff --git a/src/react-app-env.d.ts b/src/react-app-env.d.ts
@@ -0,0 +1 @@
+/// <reference types="react-scripts" />
diff --git a/src/serviceWorker.ts b/src/serviceWorker.ts
@@ -0,0 +1,149 @@
+// This optional code is used to register a service worker.
+// register() is not called by default.
+
+// This lets the app load faster on subsequent visits in production, and gives
+// it offline capabilities. However, it also means that developers (and users)
+// will only see deployed updates on subsequent visits to a page, after all the
+// existing tabs open on the page have been closed, since previously cached
+// resources are updated in the background.
+
+// To learn more about the benefits of this model and instructions on how to
+// opt-in, read https://bit.ly/CRA-PWA
+
+const isLocalhost = Boolean(
+  window.location.hostname === 'localhost' ||
+    // [::1] is the IPv6 localhost address.
+    window.location.hostname === '[::1]' ||
+    // 127.0.0.0/8 are considered localhost for IPv4.
+    window.location.hostname.match(
+      /^127(?:\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}$/
+    )
+);
+
+type Config = {
+  onSuccess?: (registration: ServiceWorkerRegistration) => void;
+  onUpdate?: (registration: ServiceWorkerRegistration) => void;
+};
+
+export function register(config?: Config) {
+  if (process.env.NODE_ENV === 'production' && 'serviceWorker' in navigator) {
+    // The URL constructor is available in all browsers that support SW.
+    const publicUrl = new URL(
+      process.env.PUBLIC_URL,
+      window.location.href
+    );
+    if (publicUrl.origin !== window.location.origin) {
+      // Our service worker won't work if PUBLIC_URL is on a different origin
+      // from what our page is served on. This might happen if a CDN is used to
+      // serve assets; see https://github.com/facebook/create-react-app/issues/2374
+      return;
+    }
+
+    window.addEventListener('load', () => {
+      const swUrl = `${process.env.PUBLIC_URL}/service-worker.js`;
+
+      if (isLocalhost) {
+        // This is running on localhost. Let's check if a service worker still exists or not.
+        checkValidServiceWorker(swUrl, config);
+
+        // Add some additional logging to localhost, pointing developers to the
+        // service worker/PWA documentation.
+        navigator.serviceWorker.ready.then(() => {
+          console.log(
+            'This web app is being served cache-first by a service ' +
+              'worker. To learn more, visit https://bit.ly/CRA-PWA'
+          );
+        });
+      } else {
+        // Is not localhost. Just register service worker
+        registerValidSW(swUrl, config);
+      }
+    });
+  }
+}
+
+function registerValidSW(swUrl: string, config?: Config) {
+  navigator.serviceWorker
+    .register(swUrl)
+    .then(registration => {
+      registration.onupdatefound = () => {
+        const installingWorker = registration.installing;
+        if (installingWorker == null) {
+          return;
+        }
+        installingWorker.onstatechange = () => {
+          if (installingWorker.state === 'installed') {
+            if (navigator.serviceWorker.controller) {
+              // At this point, the updated precached content has been fetched,
+              // but the previous service worker will still serve the older
+              // content until all client tabs are closed.
+              console.log(
+                'New content is available and will be used when all ' +
+                  'tabs for this page are closed. See https://bit.ly/CRA-PWA.'
+              );
+
+              // Execute callback
+              if (config && config.onUpdate) {
+                config.onUpdate(registration);
+              }
+            } else {
+              // At this point, everything has been precached.
+              // It's the perfect time to display a
+              // "Content is cached for offline use." message.
+              console.log('Content is cached for offline use.');
+
+              // Execute callback
+              if (config && config.onSuccess) {
+                config.onSuccess(registration);
+              }
+            }
+          }
+        };
+      };
+    })
+    .catch(error => {
+      console.error('Error during service worker registration:', error);
+    });
+}
+
+function checkValidServiceWorker(swUrl: string, config?: Config) {
+  // Check if the service worker can be found. If it can't reload the page.
+  fetch(swUrl, {
+    headers: { 'Service-Worker': 'script' }
+  })
+    .then(response => {
+      // Ensure service worker exists, and that we really are getting a JS file.
+      const contentType = response.headers.get('content-type');
+      if (
+        response.status === 404 ||
+        (contentType != null && contentType.indexOf('javascript') === -1)
+      ) {
+        // No service worker found. Probably a different app. Reload the page.
+        navigator.serviceWorker.ready.then(registration => {
+          registration.unregister().then(() => {
+            window.location.reload();
+          });
+        });
+      } else {
+        // Service worker found. Proceed as normal.
+        registerValidSW(swUrl, config);
+      }
+    })
+    .catch(() => {
+      console.log(
+        'No internet connection found. App is running in offline mode.'
+      );
+    });
+}
+
+export function unregister() {
+  if ('serviceWorker' in navigator) {
+    navigator.serviceWorker.ready
+      .then(registration => {
+        registration.unregister();
+      })
+      .catch(error => {
+        console.error(error.message);
+      });
+  }
+}
diff --git a/src/setupTests.ts b/src/setupTests.ts
@@ -0,0 +1,5 @@
+// jest-dom adds custom jest matchers for asserting on DOM nodes.
+// allows you to do things like:
+// expect(element).toHaveTextContent(/react/i)
+// learn more: https://github.com/testing-library/jest-dom
+import '@testing-library/jest-dom/extend-expect';
diff --git a/src/styles/index.ts b/src/styles/index.ts
@@ -0,0 +1,2 @@
+export { default as GlobalStyles, Container } from './style';
+export { default as theme } from './theme';
diff --git a/src/styles/style.ts b/src/styles/style.ts
@@ -0,0 +1,22 @@
+import styled, { createGlobalStyle } from 'styled-components';
+
+export default createGlobalStyle`
+    * {
+        margin: 0;
+        padding: 0;
+        box-sizing: border-box;
+    }
+
+    body {
+        font-size: 16px;
+        font-family: ${(props) => props.theme.font.family.montserrat};
+        -webkit-font-smoothing: antialiased;
+        -moz-osx-font-smoothing: grayscale;
+    }
+`;
+
+export const Container = styled.div`
+    width: 30%;
+    background: ${(props) => props.theme.colors.primary};
+    height: 400px;
+`;
diff --git a/src/styles/theme.ts b/src/styles/theme.ts
@@ -0,0 +1,21 @@
+export default {
+    colors: {
+        primary: '#689F38',
+        secondary: '#8BC34A',
+        white: '#FFFFFF',
+        dark: '#333333',
+        white_alpha_05: 'rgba(255,255,255,0.5)',
+        dark_alpha_05: 'rgba(0,0,0,0.5)',
+    },
+    font: {
+        family: {
+            montserrat: "'Montserrat', sans-serif",
+        },
+        sizes: {
+            large: '3rem',
+            medium: '2rem',
+            normal: '1.2rem',
+            small: '0.8rem',
+        },
+    },
+};
diff --git a/tsconfig.json b/tsconfig.json
@@ -0,0 +1,19 @@
+{
+    "compilerOptions": {
+        "target": "es5",
+        "lib": ["dom", "dom.iterable", "esnext"],
+        "allowJs": true,
+        "skipLibCheck": true,
+        "esModuleInterop": true,
+        "allowSyntheticDefaultImports": true,
+        "strict": true,
+        "forceConsistentCasingInFileNames": true,
+        "module": "esnext",
+        "moduleResolution": "node",
+        "resolveJsonModule": true,
+        "isolatedModules": true,
+        "noEmit": true,
+        "jsx": "react"
+    },
+    "include": ["src"]
+}
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		export { default as Dashboard } from './dashboard/dashboard';
		export { default as Settings } from './settings/settings';
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		export { default as GlobalStyles, Container } from './style';
		export { default as theme } from './theme';