Overview
Juggernaut is an unstoppable boilerplate designed for front-end developers working on React projects at Luizalabs. It sets patterns and provides a default configuration and front-end architecture for React projects. The main goal of Juggernaut is to provide a standardized approach for building React applications at Luizalabs.
Features
- Demo: Examples of how to use Juggernaut
- Demo repository: Juggernaut demo source code
- Requirements: Supports Node.js version v14.x
- Startup: Step by step guide to get Juggernaut up and running
- Patterns: Definitions of patterns and configurations to maintain a default setup
- NPM or Yarn: Allows a choice between npm or yarn package manager
- UI Kit library: Recommends using MaterialUI for UI components
- Linter: Recommends using Gandalf Lint for code linting
- Component pattern: Provides a component pattern for code organization
- Formik: Reasons for using Formik library
- Axios: Reasons for using Axios library
- Material: Reasons for using Material design principles
- Project structure: Overview of the project structure and folder organization
- License: MIT License
Installation
To install Juggernaut, follow these steps:
- Clone the repository and navigate to the project folder:
$ git clone <repository_url>
$ cd <project_folder>
- Install the dependencies:
$ npm install
- Start the server:
$ npm start
Summary
Juggernaut is an unstoppable boilerplate designed to provide patterns and configurations for front-end developers working on React projects at Luizalabs. It offers a default setup for React applications, including a choice between npm or yarn package manager, the use of MaterialUI for UI components, Gandalf Lint for code linting, and a component pattern for code organization. It also provides examples and documentation for using Juggernaut effectively. Overall, Juggernaut aims to streamline the development process and ensure a consistent approach to building React applications at Luizalabs. The project is licensed under the MIT License.