This project is a React template designed to accelerate development by providing essential features such as state management, internationalization, data fetching, navigation, and UI components with Chakra UI.
Created using the default components provided in the project.
-
🌍 Internationalization (i18n)
- Multi-language support using
react-i18next
for seamless localization.
- Multi-language support using
-
🗃️ State Management with Redux
- Centralized state management for efficient global state access and updates.
-
🔍 Data Fetching with React Query
- Optimized data fetching, caching, and synchronization.
-
🧭 Navigation
- Smooth and intuitive navigation using
react-router-dom
.
- Smooth and intuitive navigation using
-
⚛️ Component-Based Architecture
- Modular design with reusable UI components and consistent styling using Chakra UI.
-
📦 Common Utilities
- Helper functions and utilities for streamlined development.
-
🔗 Axios Management
- Configurable API requests using Axios with built-in error handling and response management.
-
🌐 WebSocket Management
- Real-time communication support using WebSockets.
-
🍪 Cookie Management
- Simplified management of cookies for authentication and user sessions.
-
🔒 Authentication
- User authentication and registration with secure token management.
Ensure you have the following installed:
- Node.js (v14 or higher)
- Yarn
- A code editor (e.g., VSCode)
-
Clone the repository:
git clone [email protected]:ToniDarodda/react-template.git cd react-template
-
Install dependencies:
yarn install
-
Configure environment variables:
Update the
.env
file in the root directory with your configuration settings:REACT_APP_API_URL='https://your-api-url.com' REACT_APP_SOCKET_URL='https://your-socket-url.com'
-
Start the development server:
yarn start
-
Open the application:
The app will be available at
http://localhost:3000
in your web browser.
To run the tests, use the following command:
yarn test
- 🧹 Format code using Prettier:
yarn format
- 🏃♂️ Start the application:
yarn start
- 🔍 Lint the code using ESLint:
yarn lint
- 🧪 Run the tests:
yarn test
- 🚀 Run end-to-end tests:
yarn test:e2e
There is no license, you're free to use it.
- 🚀 Deployment
- ⚙️ Configuration
- 📄 Documentation
- 🔧 Maintenance
- 🔒 Security
- 📫 Email Integration
- 📈 Performance Optimization
- ⚡ Gain Time
Feel free to contribute to this project by submitting issues or pull requests.
For any questions or support, please contact Toni Da Rodda.