A frontend-boilerplate to make easy to start new projects. Configured with TypesScript, React, Webpack, Babel, SASS, Axios, React Router DOM, ES Lint, Stylelint, Jest, Testing Library, Cypress, Git and, Husky.

To make it easy for you to get started with GitLab, here's a list of recommended next steps.

Already a pro? Just edit this README.md and make it your own. Want to make it easy? Use the template at the bottom!

• Create or upload files
• Add files using the command line or push an existing Git repository with the following command:

cd existing_repo
git remote add origin https://gitlab.com/openflowlabs/frontend-pocs/sphinx-frontend-boilerplate.git
git branch -M main
git push -uf origin main

• Set up project integrations

• Invite team members and collaborators
• Create a new merge request
• Automatically close issues from merge requests
• Automatically merge when pipeline succeeds

Use the built-in continuous integration in GitLab.

• Get started with GitLab CI/CD
• Analyze your code for known vulnerabilities with Static Application Security Testing(SAST)
• Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy
• Use pull-based deployments for improved Kubernetes management

When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thank you to makeareadme.com for this template.

Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.

Choose a self-explaining name for your project.

Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.

On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.

Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.

Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.

Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.

Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.

If you have ideas for releases in the future, it is a good idea to list them in the README.

State if you are open to contributions and what your requirements are for accepting them.

For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.

You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.

Show your appreciation to those who have contributed to the project.

For open source projects, say how it is licensed.

If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.

• Recommended IDE VS Code

  • How to install VS Code on Linux
  • How to install VS Code on Mac OS
  • How to install VS Code on Windows

• How to run this app
  • Node Package Manager
  • Node Version Manager
  • Install packages
  • Run on Development
  • Build Production
  • Run Tests
  • Linting
• Built with
  • Node Package Manager
  • Node Version Manager
  • Node
  • React
  • Typescript
  • Webpack
  • Babel
  • SASS
  • React Router DOM -router-dom
  • Axios
  • ES Lint
  • Jest
  • Husky
• Folder structure
  • Atomic Design
  • Adapting from Atomic Design
  • Suggested folder structure
  • Root and src folders
  • Tests folder
• Questions and answers
  • Why TypeScript
  • What is Webpack
  • What is Babel
  • What is ES Lint
  • What is Prettier
  • What is Stylelint
  • What is .editorconfig
  • Why SASS
  • Why index.ejs
  • Why __tests__ folder
  • Why Husky
• Troubleshooting
• To do
• Recommended IDE extensions
• Recommended VS CODE settings.json

In order to install packages and run this application, you will need Node Package Manager v6.14.15 or higher

This application is running on Node version 14.18.0 LTS

1. To change the Node version on IDE, open a new terminal and:

nvm use

2. If you don't have the LTS version, install it with Node Version Manager:

nvm install --lts

3. To set the LTS version as default on your terminal:

nvm alias default v14.18.0

4. To check if the Node versions is the correct:

node --version

And you should see v14.18.0

To install all the node_modules packages:

npm install

To run on Development mode:

npm start

Build production mode:

npm run build

Build and Run within a 🐋 Docker Container:

sudo docker build --tag react . && sudo docker run --publish 5010:5010 react

To run tests:

npm test

Tests coverage:

npm run test:coverage

To run tests on watch mode:

npm test --watchAll <fileName>

SCSS files:

npx stylelint **/*.scss

styles.ts files:

npx stylelint **/*.styles.ts

TypeScript files:

npm run eslint --ext .tsx,.ts src

All files:

npm run lint

Husky is already configured and commited. All you have to do is commit your changes.

Check the docs for more details Husky if you need to install it locally.

package.json

"husky": {
    "hooks": {
        "pre-commit": "npm lint",
        "pre-push": "npm test"
    }
},

• Node Package Manager

  • How to install

  • How to install on Linux

• Node Version Manager

  • How to install

• Node

  • How to install with Node Version Manager

  • How to install on Linux

• React

  • How to install with Webpack

  • Useful sources:

    • create-react-app
    • react-typescript-cheatsheet
    • learn

• Typescript

  • How to install

  • How to init tesconfig

  • Useful sources:

    • Typescript for new programmers
    • Typescript for Javascript programmers
    • Typescript handbook
    • Typescript declaration files
    • Typescript projects configurations
    • Typescript from zero to hero - PT-BR 🇧🇷

  • @Types and Plugins:

    • @tsconfig/recommended
    • @types/node
    • @types/react
    • @types/react-dom
    • @types/react-router-dom
    • @types/webpack
    • @types/webpack-dev-server
    • @typescript-eslint/eslint-plugin
    • @typescript-eslint/parser

• Webpack

  • How to install

  • Webpack getting started

  • Webpack asset management

  • Webpack output management

  • Webpack loaders

  • Webpack Typescript

  • Webpack concepts

  • Modules:

    • webpack
    • webpack-cli command line interface
    • webpack-dev-server see also devServer
    • webpack-merge

  • Plugins:

    • Officials:

      • html-webpack-plugin basic for HTML files
      • mini-css-extract-plugin extracts CSS into separate files
      • compression-webpack-plugin compressed version of assets
      • terser-webpack-plugin minify Javascript

    • Third Parties:

      • favicons-webpack-plugin configs favicons
      • fork-ts-checker-notifier-webpack-plugin
      • fork-ts-checker-webpack-plugin

  • Loaders:

    • Transpiling:

      • babel-loader
      • url-loader
      • ts-loader
      • file-loader
      • extract-loader

    • Styling:

      • autoprefixer
      • postcss-loader
      • css-loader
      • sass-loader
      • style-loader

• Babel

  • Officials:

    • @babel/core
    • @babel/preset-env
    • @babel/preset-react
    • @babel/preset-typescript
    • @babel/runtime
    • @babel/plugin-transform-runtime

  • Third Parties:

    • @babel/eslint-parser
    • babel-plugin-module-resolver
    • babel-plugin-transform-react-remove-prop-types

• ES Lint

  • How to install

    • eslint-config-prettier
    • eslint-config-standard
    • eslint-plugin-import
    • eslint-plugin-node
    • eslint-plugin-prettier
    • eslint-plugin-promise
    • eslint-plugin-react
    • eslint-plugin-react-hooks
    • eslint-plugin-react-perf
    • eslint-plugin-unicorn

• SASS

  • Required for Webpack:

    • file-loader
    • extract-loader
    • autoprefixer
    • postcss-loader
    • css-loader
    • sass-loader

• To import Bootstrap SCSS and normalize CSS

/App.scss

@import '~bootstrap/scss/bootstrap';

* {
    box-sizing: border-box;
    margin: 0;
    padding: 0;
}

body {
    height: 100vh;
    width: 100vw;
}

...

• React Router DOM

/Routes.tsx

import React from 'react'
import { Route, Switch } from 'react-router-dom'

const HomePage = React.lazy(() => import('@pages/HomePage'))

const Routes: React.FC = () => {
    return (
        <Switch>
            <Route exact path="/">
                <React.Suspense fallback={<div>Carregando...</div>}>
                    <HomePage />
                </React.Suspense>
            </Route>
        </Switch>
    )
}

export default Routes

• /App.tsx

import { ConnectedRouter } from 'connected-react-router'
import React from 'react'
import { Provider as ReduxStoreProvider } from 'react-redux'
import styled, { ThemeProvider } from 'styled-components'

import goodContrastTheme from '@common/themes/goodContrastTheme'

import Routes from './Routes'
import store, { history } from './store'

import './App.scss'

const App: React.FC = () => {
    return (
        <ReduxStoreProvider store={store}>
            <AppProviders>
                <Routes />
            </AppProviders>
        </ReduxStoreProvider>
    )
}

export default App

export const RootThemeWrapper = styled.div`
    background: ${({ theme }) => theme.colors.background.light};
    color: ${({ theme }) => theme.colors.text.light};
`

export const AppProviders: React.FC = ({ children }) => {
    return (
        <ThemeProvider theme={goodContrastTheme}>
            <ConnectedRouter history={history}>
                <RootThemeWrapper>{children}</RootThemeWrapper>
            </ConnectedRouter>
        </ThemeProvider>
    )
}

• Axios

/src/services/api/getQuote.ts

import axios, { AxiosResponse } from 'axios'

export const getQuote = async (): Promise<AxiosResponse<never>> => {
    const url = 'https://type.fit/api/quotes'

    const result = await axios({
        url,
        method: 'GET',
        headers: {
            'Content-type': 'application/json',
        },
    })

    return result
}

• Jest

  • Required for Jest with TypeScript and Webpack:

    • @testing-library/react
    • @testing-library/dom
    • @testing-library/jest-dom
    • @testing-library/user-event
    • react-test-renderer
    • testing-library-selector
    • babel-jest
    • ts-jest
    • @types/jest
    • eslint-plugin-jest-dom
    • eslint-plugin-testing-library

  • Useful sources:

    • Tutorial Jest for React
    • Jest Webpack Guide

• Husky

  • How to install
  • How to create a hook
  • To delete a hook go to .husky folder in your project and delete the pre-commit or pre-push script
  • To create another hook just repeate How to create step

• Redux

  • Required for Redux with TypeScript and React Router DOM:

    • react-redux
    • @types/react-redux
    • redux-thunk
    • connected-react-router
    • redux-devtools-extension

  • Useful sources:

    • React Router integration with Redux
    • Redux Thunk typing actions, store, reducers, and thunk
    • Redux DevTools Chrome Extension

    ├── atoms/
    │
    ├── molecules/
    │
    ├── organisms/
    │
    ├── templates/
    │
    ├── pages/

   src/
    ├── components/
    │       ├── atoms/
    │       ├── molecules/
    │       └── organisms/
    │
    ├── layouts|templates/
    │
    ├── pages/

For components, layouts, and pages

    ├── HeaderComponent/
    │       ├── HeaderComponent.tsx
    │       ├── index.(scss|styles.ts)
    │       └── index.ts
   ...
    ├── HomeLayout/
    │       ├── HomeLayout.tsx
    │       ├── index.(scss|styles.ts)
    │       └── index.ts
   ...
    ├── HomePage/
    │       ├── HomePage.tsx
    │       ├── index.(scss|styles.ts)
    │       └── index.ts

    /
    ├── .husky/                 <!-- generated afer run `npx husky install` -->
    ├── build/                  <!-- generated afer run `npm start` -->
    ├── dist/                   <!-- generated afer run `npm build` -->
    ├── node_modules/           <!-- generated afer run `npm install` -->
    ├── public/
    ├── src/
    │    ├── __tests__/
    │    ├── common/
    │    ├── components/
    │    ├── layouts/
    │    ├── pages/
    │    ├── services/
    │    ├── App.scss
    │    ├── App.tsx
    │    ├── index.ejs
    │    ├── index.tsx
    │    └── Routes.tsx
    ├── .editorconfig
    ├── .eslintignore
    ├── .eslintrc.json
    ├── .gitignore
    ├── .node-version
    ├── .nvmrc
    ├── .prettierignore
    ├── .prettierrc
    ├── .stylelintignore
    ├── .stylelintrc.json
    ├── babel.config.js
    ├── docker-compose.yml
    ├── Dockerfile
    ├── package-lock.json
    ├── package.json
    ├── postcss.config.js
    ├── README.md
    ├── tsconfig.json
    ├── webpack.config.js
    ├── webpack.development.js
    └── webpack.production.js

For components, layouts, and pages

  pages/
    ├── HomePage/
    │       ├── HomePage.tsx
    │       ├── index.(scss|styles.ts)
    │       └── index.ts
   ...

    __tests__/
        ├── app/
        ├── coverage/                   <!-- generated afer run `npm test` -->
        ├── helpers/
        └── mocks/


    __tests__/app/
                ├── components/
                ├── layouts/
                └── pages/

    __tests__/app/components/
                        ├── atoms/
                        ├── molecules/
                        └── organisms/

    __tests__/app/components/atoms/InnerLink.(test|spec).tsx
    __tests__/app/components/atoms/ListItem.(test|spec).tsx
    __tests__/app/components/atoms/OuterLink.(test|spec).tsx

    __tests__/app/components/molecules/TechList.(test|spec).tsx

    __tests__/app/components/organisms/HomeNav.(test|spec).tsx

    __tests__/app/layouts/HomeMain.(test|spec).tsx

    __tests__/app/pages/HomePage.(test|spec).tsx

• Improves a lot the development experience. Has a lot of features that JavaScript does not have. Having a strong sinergy with Webpack, Babel, and ES Lint. Types makes the code basis easier to read and mantain. And it also boosts your knowledge about React and JavaScript. Since we have to care about every type of JSX Elements, DOM Events, functions, objects, and so on.
• Customize our projects configurations connecting plugins with Webpack, Babel, and ES Lint. Imports management, folder and file paths alias, and others environments options. Are all available on tsconfig.json file.

• Webpack is a static module bundler for modern JavaScript applications. When webpack processes your application, it internally builds a dependency graph from one or more entry points and then combines every module your project needs into one or more bundles, which are static assets to serve your content from. Concepts

• Babel is a JavaScript compiler
• See also don-t-use-create-react-app-how-you-can-set-up-your-own-reactjs-boilerplate

• ESLint is a tool for identifying and reporting on patterns found in ECMAScript/JavaScript code, with the goal of making code more consistent and avoiding bugs.
• Ensures that every person that is working on this code basis is writing on the same pattern. Following the same linting rules and avoiding anti-patterns from being commited and pushed. Combined with Husky.
• See also eslint-plugin

• An opinionated code formatter. You press save and code is formatted.
• Need to install Prettier extension for yor IDE in order to automate foarmat on save and/or format on paste options.

• Same as ES Lint but for styles files like .scss, .css, .less, etc.

• To ensure all environments that are running this application are also running the same Node version.

• EditorConfig helps maintain consistent coding styles for multiple developers working on the same project across various editors and IDEs.

• CSS is hard to maintain. SASS is more porwerfull 💥. And there are plenty of UI libraries that supports SASS.
• UI libraries that supports SASS:
  • Bootstrap
  • Material Design
  • Materialize

• Webpack relative or absolute path to the template. By default it will use src/index.ejs if it exists. Please see the docs for details.
• EJS is just a way to warite some JS on HTML. Since we need to capture values from HtmlWebpackPlugin.
• See html-webpack-plugin
• See also template-option

• The main idea here is to keep all files related to tests separated from others src folder files. By doing this, we prevent Webpack to load files with .test and .spec extensions. And other files that are only useful on test environment. Like mocks, Provider and jest-setup from utils.
• coverage is a special folder that comes in when any test is runned. This is an automatic configuration placed on jest.config.js on key coverageDirectory
• Unit tests will be applied to components, layouts, and pages.
• End-to-End tests will be runned with Cypress further.

• Husky improves your commits and more 🐶 woof!
• To avoid having unlinted code in our repository, what we can do is add ESLint at one point of our process using Git Hooks. Like Husky!

• Supposing this application will scale and grow larger, Redux is more recommended.

• Even though we have to write more code, Redux is easier to understand. Because it organises better the state management.

• A lot of people know how to use Redux. Specially if this person cames from another language/framework. Context is only for React.

• Context is a very rencent API. Only full available from React 16.8 to above.

• Useful resourcers:

  • Redux-vs-Context
  • Context-Redux-differences
  • Useing-hooks-and-context-not-react-and-redux
  • Redux-vs-Context-why-and-where
  • Starting-a-new-app-with-redux-consider-context-api-first
  • Redux-vs-Context-why-and-where
  • Redux-vs-react-context-PT-BE

• Common is a place for assets, functions, hooks, themes, types, and wahtever you may need to share with the rest of the application.
• Is also useful to place third party libraries configurations and setups. Keeping it on a place where you know where to find.
• Good place for reusable code. In order to keep the application simple and dry. And reducing responsabilities from components.

• On deploy, you must set build production folder to dist/ instead of /.

• To Do

settings.json

{
  "auto-close-tag.activationOnLanguage": ["*"],
  "code-runner.clearPreviousOutput": true,
  "code-runner.runInTerminal": true,
  "editor.autoClosingBrackets": "always",
  "editor.codeActionsOnSave": {
    "source.fixAll.eslint": true,
    "source.fixAll.stylelint": true
  },
  "editor.defaultFormatter": "dbaeumer.vscode-eslint",
  "editor.suggestSelection": "first",
  "editor.tabCompletion": "on",
  "editor.tabSize": 4,
  "emmet.showSuggestionsAsSnippets": true,
  "emmet.includeLanguages": {
    "javascript": "javascriptreact",
    "ejs": "html"
  },
  "eslint.useESLintClass": true,
  "eslint.workingDirectories": ["./"],
  "files.exclude": {
    "**/.classpath": true,
    "**/.project": true,
    "**/.settings": true,
    "**/.factorypath": true
  },
  "files.associations": {
    "**/*.html": "html",
    "*.md": "mdx"
  },
  "git.autoRepositoryDetection": "openEditors",
  "gitlens.gitCommands.search.showResultsInSideBar": true,
  "gitlens.hovers.annotations.over": "annotation",
  "gitlens.hovers.annotations.changes": false,
  "gitlens.hovers.annotations.details": false,
  "gitlens.hovers.autolinks.enabled": false,
  "gitlens.hovers.autolinks.enhanced": false,
  "gitlens.hovers.avatars": false,
  "gitlens.hovers.currentLine.changes": false,
  "gitlens.hovers.currentLine.enabled": false,
  "gitlens.hovers.currentLine.details": false,
  "gitlens.hovers.pullRequests.enabled": false,
  "importCost.smallPackageSize": 10,
  "importCost.mediumPackageSize": 20,
  "importCost.mediumPackageColor": "#CCBC00",
  "javascript.format.insertSpaceAfterOpeningAndBeforeClosingNonemptyBrackets": true,
  "javascript.updateImportsOnFileMove.enabled": "always",
  "liveServer.settings.donotVerifyTags": true,
  "liveServer.settings.donotShowInfoMsg": true,
  "material-icon-theme.folders.associations": {
    "widgets": "components",
    "front-angular": "font",
    "front-react": "React-Components",
    "front-vue": "vue",
    "store": "Redux-store",
    "actions": "redux-actions",
    "reducers": "redux-reducer",
    "atoms": "React-components",
    "molecules": "Node",
    "organisms": "Other",
    "favicons": "Admin",
    "modules": "Home",
    "http": "Global",
    "typeorm": "Database",
    "migrations": "Expo",
    "entities": "Class",
    "repositories": "Log",
    "requirements": "Rules"
  },
  "material-icon-theme.files.associations": {
    "ormconfig.json": "Database"
  },
  "stylelint.validate": ["css", "scss"],
  "typescript.updateImportsOnFileMove.enabled": "always",
  "vsintellicode.modify.editor.suggestSelection": "automaticallyOverrodeDefaultValue",
  "workbench.colorTheme": "Dracula",
  "workbench.iconTheme": "material-icon-theme",
  "workbench.tree.indent": 20,
  "window.zoomLevel": 0,
}