React Ant Design Starter
This project was modified from boilerplate created by Create React App.
New Features
- Use
.babelrc
file for babel configuration. - Use
config/jest.config.js
file for jest configuration. - Add
raf
polyfill for jest test. - Use JavaScript Standard Style
- Add eslint plugins for JavaScript Standard Style.
- Use Ant Design for UI.
- Use husky git hooks, for lint checking before commit.
- Source map explorer analyzes JavaScript bundles using the source maps
Start
git clone https://github.com/yugasun/react-ant-design-starter.git my-appcd my-appyarn install
Folder Structure
After creation, your project should look like this:
my-app/
README.md
node_modules/
package.json
.babelrc
.eslintrc.js
.eslintignore
config/ // include webpack config and jest config
public/
index.html
favicon.ico
scripts/
src/
__test__/ // test folder
App.test.js
App.css
App.js
index.css
index.js
logo.svg
For the project to build, these files must exist with exact filenames:
public/index.html
is the page template;src/index.js
is the JavaScript entry point.
You can delete or rename the other files.
You may create subdirectories inside src
. For faster rebuilds, only files inside src
are processed by Webpack.
You need to put any JS and CSS files inside src
, otherwise Webpack won’t see them.
Only files inside public
can be used from public/index.html
.
Read instructions below for using assets from JavaScript and HTML.
You can, however, create more top-level directories.
They will not be included in the production build so you can use them for things like documentation.
Available Scripts
In the project directory, you can run:
yarn start
Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.
The page will reload if you make edits.
You will also see any lint errors in the console.
yarn test
Launches the test runner in the interactive watch mode.
See the section about running tests for more information.
yarn build
Builds the app for production to the build
folder.
It correctly bundles React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.
yarn analyze
Source map explorer analyzes JavaScript bundles using the source maps. This helps you understand where code bloat is coming from.