https://github.com/nicolasschwarzer/web-console-boilerplate

A boilerplate of web console project which saves your time on project initialization.
https://github.com/nicolasschwarzer/web-console-boilerplate

boilerplate eslint react stylelint webpack

Last synced: 2 months ago
JSON representation

A boilerplate of web console project which saves your time on project initialization.

• Host: GitHub
• URL: https://github.com/nicolasschwarzer/web-console-boilerplate
• Owner: NicolasSchwarzer
• License: mit
• Created: 2019-03-24T12:26:42.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2019-12-20T09:01:08.000Z (over 6 years ago)
• Last Synced: 2025-01-28T02:25:28.315Z (over 1 year ago)
• Topics: boilerplate, eslint, react, stylelint, webpack
• Language: JavaScript
• Homepage: https://github.com/NicolasSchwarzer/web-console-boilerplate
• Size: 106 KB
• Stars: 1
• Watchers: 1
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
English | [简体中文](./README_zh-CN.md)

# Web Console Boilerplate

[![LGTM Alerts](https://img.shields.io/lgtm/alerts/github/NicolasSchwarzer/web-console-boilerplate)](https://lgtm.com/projects/g/NicolasSchwarzer/web-console-boilerplate/alerts/) [![LGTM Grade](https://img.shields.io/lgtm/grade/javascript/github/NicolasSchwarzer/web-console-boilerplate)](https://lgtm.com/projects/g/NicolasSchwarzer/web-console-boilerplate/alerts/) [![Dependencies](https://img.shields.io/david/NicolasSchwarzer/web-console-boilerplate)](https://david-dm.org/NicolasSchwarzer/web-console-boilerplate) [![Dev Dependencies](https://img.shields.io/david/dev/NicolasSchwarzer/web-console-boilerplate)](https://david-dm.org/NicolasSchwarzer/web-console-boilerplate?type=dev) [![GitHub Issues](https://img.shields.io/github/issues/NicolasSchwarzer/web-console-boilerplate)](https://github.com/NicolasSchwarzer/web-console-boilerplate/issues) [![GitHub Pull Requests](https://img.shields.io/github/issues-pr/NicolasSchwarzer/web-console-boilerplate)](https://github.com/NicolasSchwarzer/web-console-boilerplate/pulls) [![GitHub License](https://img.shields.io/github/license/NicolasSchwarzer/web-console-boilerplate)](https://github.com/NicolasSchwarzer/web-console-boilerplate/blob/master/LICENSE) [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2FNicolasSchwarzer%2Fweb-console-boilerplate.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2FNicolasSchwarzer%2Fweb-console-boilerplate?ref=badge_shield) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](./CONTRIBUTING.md#your-first-pull-request)

A boilerplate of web console project which saves your time on project initialization.

## Features

* **Web project boilerplate**, aims for React developers, with React Router and Ant Design engaged.

* **Full usage of React new features**, includes strict mode, error boundaries, lazy load, memoization, fragments, Hooks and so on...

* **Webpack configuration with best practice**, supports tree shaking, code splitting, persistant cache, live reload, bundle analysis and so on...

* **Code style check**, automatically runs ESLint and StyleLint on Git commit, whose rules are based on `eslint-config-airbnb` and `stylelint-config-standard`.

  * **Please notice**: Here uses ESLint 5.x.x instead of latest 6.x.x, because of the incompatibility between 6.x.x and [the VSCode extension](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint). For more details, please refer to issue [#696](https://github.com/microsoft/vscode-eslint/issues/696) and comment [#507855728](https://github.com/microsoft/vscode-eslint/issues/696#issuecomment-507855728).

## Getting Started

```shell

# Install dependencies.

$ npm install

# Start dev server.

$ npm start

# Get production build.

$ npm run build

# Check code style.

$ npm run lint

# Fix code style.

$ npm run lint-fix

```

## Usage

This repository is a boilerplate, I recommend you make a copy of it to start your own project. **Please note that you should remove the `.npmrc` file in favor of generating a `package-lock.json` file for better reliability**.

## Contributing

Welcome all contributions. Please read the [Contributing Guide](./CONTRIBUTING.md) first.

## License

[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2FNicolasSchwarzer%2Fweb-console-boilerplate.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2FNicolasSchwarzer%2Fweb-console-boilerplate?ref=badge_large)