Web Project Boilerplate

This web template is an empty project prepared with primary software libraries and configurations needed to begin developing a React web application.

It also has basic sample components, tests, and demonstrations of working with tools such as React-Router or Storybook.

The project is ready to work with our React Native mobile app template and our server template, providing a unified experience among the three.

Components

• React as front-end view library.

• Mobx for state management.

• Antd as UI framework.

• Storybook for agile development environment.

• TypeScript as main language.

• Babel for JavaScript transpiling.

• Jest as as test framework.

• SASS as CSS pre-processing.

• LESS as CSS pre-processing.

• Prettier for code formatter.

• ESlint for JavaScript/TypeScript linting.

• StyleLint for SASS/LESS/CSS linting.

• Husky for Git hooks support.

• Lint-staged to run linters on git staged files.

• Bundlesize to check size of bundle's files.

This boilerplate uses Create React App

Getting Started

Run the following commands in your terminal

git clone https://github.com/orangeloops/public-ol-web-template.git
cd public-ol-web-template
npm install
npm run start

Then open http://localhost:5000/ on your web browser.

Testing

Run npm test for test.

Deploying

For deployment, run npm run build and upload build/ to your server.

License

You can check out the full license here

This project is licensed under the terms of the MIT license.

orangeloops.com  ·  twitter  ·  blog