react-ts-scss-sass-css-boilerplate

CrispenGari · Aug 27, 2021 · 8921ac7 · 8921ac7
1 parent a419e8a
commit 8921ac7
Show file tree

Hide file tree

Showing 25 changed files with 12,411 additions and 101 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,104 +1,23 @@
-# Logs
-logs
-*.log
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
-lerna-debug.log*
-
-# Diagnostic reports (https://nodejs.org/api/report.html)
-report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
-
-# Runtime data
-pids
-*.pid
-*.seed
-*.pid.lock
-
-# Directory for instrumented libs generated by jscoverage/JSCover
-lib-cov
-
-# Coverage directory used by tools like istanbul
-coverage
-*.lcov
-
-# nyc test coverage
-.nyc_output
-
-# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
-.grunt
-
-# Bower dependency directory (https://bower.io/)
-bower_components
-
-# node-waf configuration
-.lock-wscript
-
-# Compiled binary addons (https://nodejs.org/api/addons.html)
-build/Release
-
-# Dependency directories
-node_modules/
-jspm_packages/
-
-# TypeScript v1 declaration files
-typings/
-
-# TypeScript cache
-*.tsbuildinfo
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
 
-# Optional npm cache directory
-.npm
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
 
-# Optional eslint cache
-.eslintcache
+# testing
+/coverage
 
-# Microbundle cache
-.rpt2_cache/
-.rts2_cache_cjs/
-.rts2_cache_es/
-.rts2_cache_umd/
+# production
+/build
 
-# Optional REPL history
-.node_repl_history
+# misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
 
-# Output of 'npm pack'
-*.tgz
-
-# Yarn Integrity file
-.yarn-integrity
-
-# dotenv environment variables file
-.env
-.env.test
-
-# parcel-bundler cache (https://parceljs.org/)
-.cache
-
-# Next.js build output
-.next
-
-# Nuxt.js build / generate output
-.nuxt
-dist
-
-# Gatsby files
-.cache/
-# Comment in the public line in if your project uses Gatsby and *not* Next.js
-# https://nextjs.org/blog/next-9-1#public-directory-support
-# public
-
-# vuepress build output
-.vuepress/dist
-
-# Serverless directories
-.serverless/
-
-# FuseBox cache
-.fusebox/
-
-# DynamoDB Local files
-.dynamodb/
-
-# TernJS port file
-.tern-port
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
diff --git a/README.md b/README.md
@@ -1,2 +1,31 @@
-# react-typescript-sass
-💎 This is a boiler plate code initializer for a React, TypeScript,  Scss, Sass or Css
+### React, TypeScript, Sass/Scss and CSS boiler Plate
+
+### Usage
+
+1. Clone the repository
+
+```shell
+git clone https://github.com/CrispenGari/react-typescript-sass.git
+```
+
+2. Changing directory to `react-typescript-sass`
+
+```shell
+react-typescript-sass
+```
+
+3. Finally
+
+```shell
+npm install
+#  Or
+yarn
+```
+
+### Staring the React Server
+
+```shell
+yarn start
+# or
+npm start
+```
diff --git a/package.json b/package.json
@@ -0,0 +1,44 @@
+{
+  "name": "react-sass-typescript",
+  "version": "0.1.0",
+  "private": true,
+  "dependencies": {
+    "@testing-library/jest-dom": "^5.11.4",
+    "@testing-library/react": "^11.1.0",
+    "@testing-library/user-event": "^12.1.10",
+    "@types/jest": "^26.0.15",
+    "@types/node": "^12.0.0",
+    "@types/react": "^17.0.0",
+    "@types/react-dom": "^17.0.0",
+    "node-sass": "4.14.1",
+    "react": "^17.0.2",
+    "react-dom": "^17.0.2",
+    "react-scripts": "4.0.3",
+    "typescript": "^4.1.2",
+    "web-vitals": "^1.0.1"
+  },
+  "scripts": {
+    "start": "react-scripts start",
+    "build": "react-scripts build",
+    "test": "react-scripts test",
+    "eject": "react-scripts eject"
+  },
+  "eslintConfig": {
+    "extends": [
+      "react-app",
+      "react-app/jest"
+    ]
+  },
+  "browserslist": {
+    "production": [
+      ">0.2%",
+      "not dead",
+      "not op_mini all"
+    ],
+    "development": [
+      "last 1 chrome version",
+      "last 1 firefox version",
+      "last 1 safari version"
+    ]
+  }
+}
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.scss b/src/App.scss
@@ -0,0 +1,49 @@
+@import "colors";
+.app {
+  width: 100vw;
+  height: 100vh;
+  background-color: white;
+  display: flex;
+  flex-direction: column;
+  user-select: none;
+  .app__main {
+    flex-direction: column;
+    display: flex;
+    justify-content: center;
+    align-items: center;
+    padding: 10px;
+    width: 100%;
+    flex: 1;
+    h1 {
+      font-weight: 500;
+      font-size: 1rem;
+      text-align: center;
+      span {
+        background-color: #f5f5f5;
+        width: fit-content;
+        padding: 0px 4px;
+        color: $span_color;
+        &:hover {
+          cursor: pointer;
+          text-decoration: underline $span_color;
+        }
+      }
+    }
+    p {
+      font-style: italic;
+      color: gray;
+      margin-top: 4px;
+      font-size: 0.9rem;
+      span {
+        background-color: #f5f5f5;
+        width: fit-content;
+        padding: 0px 4px;
+        color: $span_color;
+        &:hover {
+          cursor: pointer;
+          text-decoration: underline $span_color;
+        }
+      }
+    }
+  }
+}
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 learn react link', () => {
+  render(<App />);
+  const linkElement = screen.getByText(/learn react/i);
+  expect(linkElement).toBeInTheDocument();
+});
diff --git a/src/App.tsx b/src/App.tsx
@@ -0,0 +1,25 @@
+import React from "react";
+import "./App.scss";
+import Footer from "./components/Footer";
+import Header from "./components/Header";
+
+const App: React.FC<{}> = () => {
+  return (
+    <div className="app">
+      <Header />
+      <div className="app__main">
+        <h1>
+          Welcome to the <span>React</span>, <span>TypeScript</span>,{" "}
+          <span>Sass</span>
+          <span>Scss</span> and <span>Css</span>boiler plate.
+        </h1>
+        <p>
+          Open <span>App.tsx</span> and start writing some code
+        </p>
+      </div>
+      <Footer />
+    </div>
+  );
+};
+
+export default App;
diff --git a/src/_colors.scss b/src/_colors.scss
@@ -0,0 +1 @@
+$span_color: cornflowerblue;
diff --git a/src/components/Footer/Footer.sass b/src/components/Footer/Footer.sass
@@ -0,0 +1,14 @@
+
+.footer
+    width: 100%
+    background-color: white
+    padding: 20px
+    display: flex
+    justify-content: center
+    align-items: center
+    border-top: 1px solid cornflowerblue
+    h1
+        font-weight: 500
+        font-size: 1rem
+        cursor: pointer
+        color: cornflowerblue
diff --git a/src/components/Footer/index.tsx b/src/components/Footer/index.tsx
@@ -0,0 +1,13 @@
+import React from "react";
+import "./Footer.sass";
+const Footer = () => {
+  return (
+    <div className="footer">
+      <h1>
+        Created by <span>Crispen Gari</span>
+      </h1>
+    </div>
+  );
+};
+
+export default Footer;