React with Webpack

Author

This boilerplate was written by Marvin Petate

Goal

This project aims to give understanding to our Web Developers how to setup React Application from scratch with organized development configuration.

This configuration was based on Webpack Documentation follow the standard and best practices that recommend by Webpack, the general objective of this project is to provide light weight configuration for react development and give themselves familiarities on how webpack work.

Setup for development

Step 1:

Clone the boilerplate

git clone https://github.com/petatemarvin26/react-webpack.git . # through https
git clone [email protected]:petatemarvin26/react-webpack.git . # through ssh

Step 2:

Install dependencies

npm install # if you are using node package manager
yarn install # if using yarn packacge manager

Step 3:

Environment variables

touch .env # .env PORT=4321 HOST=1.2.3.4

NOTE: arbitrary build with env is base on the env variant at npm script .env.dev

Configure into Javascript

Step 1:

Rename the javascript configuration file from tsconfig.json to jsconfig.json

Step 2:

Install the babel-plugin-module-resolver

npm i -D babel-plugin-module-resolver

Step 3:

Implement module resolver on our config/.babelrc to resolving the relative path from jsconfig.json and remove preset @babel/preset-typescript

{
   "presets": [
      ...
      ["@babel/preset-react", {"runtime": "automatic"}]
-     ["@babel/preset-typescript"]
   ],
+ "plugins": [["module-resolver", {"root": ["./src"]}]]
}

Step 4:

Modify webpack configuration at webpack.config.js

...
const {DefinePlugin} = require('webpack');
const ESLintPlugin = require('eslint-webpack-plugin');
- const ForkTsCheckerWebpackPlugin = require('fork-ts-checker-webpack-plugin');
- const TsconfigPathsPlugin = require('tsconfig-paths-webpack-plugin');

...
const entry = {
-  index: resolver('src/index.tsx')
+  index: resolver('src/index.jsx')
};

...
const plugins = [
   ...
-  new ForkTsCheckerWebpackPlugin()
];

...
const resolve = {
-  plugins: [new TsconfigPathsPlugin()],
   extensions: ['.js', '.jsx', '.ts', '.tsx']
};

Dont forget to rename your source files *.tsx to *.jsx

Step 5:

Next is to setup your linting rules, I recommend to use @babel/eslint-parser with sample configuration

{
  "parser": "@babel/eslint-parser",
  "parserOptions": {
    "sourceType": "module",
    "babelOptions": {
      "configFile": "./config/.babelrc"
    },
    "ecmaFeatures": {
      "jsx": true
    }
  },
  "plugins": ["react"],
  "extends": ["plugin:react/recommended"],
  "settings": {
    "react": {
      "version": "detect"
    }
  },
  "rules": {
    "react/react-in-jsx-scope": "off",
    "no-unused-vars": "warn",
    "semi": ["warn", "always"],
    "quotes": ["warn", "single"],
    ...
  }
}

Step 6:

Now you can start the bundler using npm start

Contributing

As the owner of this repository I really appreciate the knowledge, suggestions of other contributors who helps to make this boilerplate more cleaner and efficient.

But for now am too busy to collaborate with, so please report an issue just incase you see something wrong on the configuration, I do appreciate.

License

Distributed under the MIT License. See LICENSE for more information.