https://github.com/rishichawda/minimal-react-boilerplate

A minimal react boilerplate with webpack 5 📦, babel v7 :rocket: and SASS support. Linting, pre-commit hooks, snapshot and DOM testing, continuous integration and more already set up. :art:
https://github.com/rishichawda/minimal-react-boilerplate

babel babel7 boilerplate eslint node-sass prettier prettier-eslint react sass webpack webpack5

Last synced: 21 days ago
JSON representation

A minimal react boilerplate with webpack 5 📦, babel v7 :rocket: and SASS support. Linting, pre-commit hooks, snapshot and DOM testing, continuous integration and more already set up. :art:

• Host: GitHub
• URL: https://github.com/rishichawda/minimal-react-boilerplate
• Owner: rishichawda
• License: mit
• Created: 2019-02-04T16:46:27.000Z (almost 6 years ago)
• Default Branch: main
• Last Pushed: 2023-10-19T07:15:44.000Z (about 1 year ago)
• Last Synced: 2024-10-02T03:23:25.325Z (about 1 month ago)
• Topics: babel, babel7, boilerplate, eslint, node-sass, prettier, prettier-eslint, react, sass, webpack, webpack5
• Language: JavaScript
• Homepage:
• Size: 1.03 MB
• Stars: 13
• Watchers: 1
• Forks: 6
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
## minimal-react-boilerplate

![](https://img.shields.io/github/package-json/v/rishichawda/minimal-react-boilerplate.svg?style=for-the-badge)

![](https://img.shields.io/github/last-commit/rishichawda/minimal-react-boilerplate?style=for-the-badge)

A minimal react boilerplate with webpack 5, babel v7 and SASS support.

- **Webpack 5** - All the good things from Webpack 5 including faster builds, smaller build sizes and more.

- **Babel 7**

- **ESLint ( with prettier config )** - give the configuration a shot and thank me later. :smile:

- **Husky** - Pre-commit lint check for staged files to ensure :poop:-code is never commited.

- **CSS and SASS support.**

- **Easy and cleaner imports with [babel module resolver](https://github.com/tleunen/babel-plugin-module-resolver).**

For example, if you have a directory structure like this:

```

src

-- components

-- config

---- secret-config.js

-- pages

---- home

------ index.js

```

You can import `secret-config.js` in `index.js` as :

```jsx

import config from "config/secret-config.js";

```

- **Environment files** - environment variable imports are already configured and added! Just create `development.env` and `production.env` ( inside config directory ) with your environment variables and start using them in your app! :tada:

- **Snapshots and DOM testing** - Includes DOM testing with [Jest](https://jestjs.io) and [react-testing-library](https://github.com/testing-library/react-testing-library) and also includes snapshot test examples with Jest. `travis.yml` is already included to run the tests on [TravisCI]().

## Usage :

1. Clone the repository via _SSH_ :

```

$ git clone [email protected]:rishichawda/minimal-react-boilerplate.git

```

or _HTTPS_ :

```

$ git clone https://github.com/rishichawda/minimal-react-boilerplate.git

```

2.

```

$ cd minimal-react-boilerplate

$ npm install

```

#### Unfamiliar with git?

Simply click [here](https://github.com/rishichawda/minimal-react-boilerplate/archive/master.zip) to download the zip. Extract the _.zip_ file and run the following commands inside the directory.

```

$ npm install

$ npm run start

```

##

To start the development server :

```

$ npm run start

```

To generate production build :

```

$ npm run build

```