/web-console-boilerplate

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

Primary LanguageJavaScriptMIT LicenseMIT

English | 简体中文

Web Console Boilerplate

LGTM Alerts LGTM Grade Dependencies Dev Dependencies GitHub Issues GitHub Pull Requests GitHub License FOSSA Status PRs Welcome

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. For more details, please refer to issue #696 and comment #507855728.

Getting Started

# 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 first.

License

FOSSA Status