Juggernaut

An unstoppable boilerplate

The main goal of Juggernaut is to set patterns to be followed by any and every Luizalabs front-end developer working on React projects.

Gif by Reuno

💻 Ecosystem

Name	Description
Demo	Examples of how to use Juggernaut
Demo repository	Juggernaut demo source code

📝 Requirements

This boilerplate supports Node.js from version v14.x

🚀 Startup

Step by step to get this up and running

Clone repo and go to project folder

$ git clone https://github.com/SoftboxLab/juggernaut.git && cd juggernaut

Install dependencies

$ npm i

Start server

$ npm run start

✔️ Patterns

These are some of patterns definitions to help us to keep a default configuration and front-end arquitecture.

NPM or Yarn? We chose npm, but feel free to make your choice;
UI Kit library? Jump into MaterialUI;
Linter: If You don't use Gandalf Lint, you shall not pass;
Do you want a component pattern? Get here;
Why Formik?
Why Axios?
Why Material?

📂 Project structure

src/assets: Static files (images, fonts and icons);
src/resources: API and endpoints configurations;
src/components: Components of React to be shared and reused in the project;
src/common: Utilities, resources, constants, assets, configurations, i18n and others;
src/containers: Page components that apply business knowledge and present themselves as pages;
src/routes: Routes of app to be used by SPA and user navigation;
src/store: State configuration with Redux;
docs: Docs configuration.

📜 License

The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

This project licence is also MIT.

luizalabs/juggernaut