Profiteam React Boilerplate

🚀 A powerful and production-ready foundation that helps you develop and maintain robust and efficient React applications. It provides a well-organized and modular structure, essential features, and best practices to accelerate your development process.

Documentation

Features

Command Line Interface

Create components, routes, entities - and their tests - right from the CLI!

Useful components

A set of very useful components that implement frequently encountered logic, such as the thing we call CRUD Page. If you need to do a lot of pages with filter and sorting logic, data list as a table with pagination, forms for creation and editing and quit a bit more, please look at the BaseCrudPage in components section.

Best Practices

Enjoy the best DX (Developer eXperience) and code your app at the speed of thought! Your saved changes to the CSS and JS are reflected instantaneously without refreshing the page. Preserve application state even when you update something in the underlying code!

Robust and Modular Structure

The boilerplate offers a robust and modular structure that makes it easy to organize and maintain your codebase.

Pre-Configured Webpack

Profiteam React Boilerplate includes a pre-configured Webpack setup that optimizes your build process and simplifies the management of assets.

Predictable state management

Unidirectional data flow allows for change logging and time travel debugging.

Next generation JavaScript

Use template strings, object destructuring, arrow functions, JSX syntax and more.

Static code analysis

Focus on writing new features without worrying about formatting or code quality. With the right editor setup, your code will automatically be formatted and linted as you work.

Test coverage

The project includes e2e testing and code coverage tools to ensure high-quality and bug-free code. We strive for 100% test coverage.

_{Keywords: React.js, Redux, redux-toolkit, Hot Reloading, ESNext, Babel, react-router, Webpack5, Cypress, Sass/Scss}

Quick start

1. Make sure that you have Node.js v16.16.0 and npm v8 or above installed.
2. Clone the Profiteam React Boilerplate repository

git clone --depth=1 https://github.com/kelian9/profiteam-react-boilerplate.git <YOUR_PROJECT_NAME>

3. Move to the appropriate directory:

cd <YOUR_PROJECT_NAME>

4. Run

npm run setup

in order to install dependencies and clean the git repo.
At this point you can run

npm start

to see the example app at http://localhost:8080.

5. Run

npm run clean

to prepare the repository for your own project.

Your boilerplate project is now ready for use! You can start building your application by modifying the files in the src directory. The boilerplate comes with basic routing and a simple Home component to get you started. To learn more about how to use React Boilerplate, check out the documentation

License

This project is licensed under the MIT license, Copyright (c) 2023 Aleksandr Karibov. For more information see LICENSE.md.