This is a React JS boilerplate build using Atomic Design Principals that you can use as a starting point for your applications. It includes some common dependencies and packages that you may want to use in your projects, as well as some example components and utilities.
- Out of the box Firebase Integration
- Material UI v5
- Protected Routing
- Professional Folder Structure
This boilerplate includes the following dependencies:
@emotion/react and @emotion/styled for CSS-in-JS styling @mui/icons-material and @mui/material for Material UI components @reduxjs/toolkit and react-redux for Redux state management firebase for Firebase integration notistack for displaying notifications react-quill for a rich text editor react-router-dom for client-side routing
To get started with this boilerplate, clone this repository to your local machine and install the dependencies using npm install.
Copy code git clone https://github.com/your-username/your-boilerplate.git cd your-boilerplate npm install To start the development server, run npm start.
Locate the file named .env.example and rename it to .env
Copy code npm start This will start the development server on http://localhost:3000 and open a browser window with your application.
To build your application for production, run npm run build. This will create a production-ready build in the build directory.
npm run build You can then deploy this build to a static hosting provider, such as Netlify or Firebase Hosting.
If you find a bug or want to suggest a new feature, please open an issue on GitHub. Pull requests are also welcome!