Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/luizalabs/juggernaut
An unstoppable boilerplate
https://github.com/luizalabs/juggernaut
boilerplate hacktoberfest javascript react
Last synced: 3 months ago
JSON representation
An unstoppable boilerplate
- Host: GitHub
- URL: https://github.com/luizalabs/juggernaut
- Owner: luizalabs
- Created: 2019-02-19T16:20:33.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-11-12T01:50:50.000Z (about 1 year ago)
- Last Synced: 2024-07-03T12:11:30.205Z (7 months ago)
- Topics: boilerplate, hacktoberfest, javascript, react
- Language: JavaScript
- Homepage: https://juggernaut-demo.web.app
- Size: 5.44 MB
- Stars: 57
- Watchers: 17
- Forks: 24
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
[](https://app.netlify.com/sites/juggernaut/deploys)
# 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
## :computer: Ecosystem
Name | Description
--- | ---
[Demo](https://juggernaut-demo.web.app/) | *Examples of how to use Juggernaut*
[Demo repository](https://github.com/SoftboxLab/juggernaut-demo) | *Juggernaut demo source code*
## :pencil: Requirements
This boilerplate supports Node.js from version v14.x
## :rocket: Startup
Step by step to get this up and running
### Clone repo and go to project folder
```bash
$ git clone https://github.com/SoftboxLab/juggernaut.git && cd juggernaut
```
### Install dependencies
```bash
$ npm i
```
### Start server
```bash
$ npm run start
```
## :heavy_check_mark: 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](https://material-ui.com);
- Linter: If You don't use [Gandalf Lint](https://github.com/SoftboxLab/gandalf-lint), you shall not pass;
- Do you want a component pattern? [Get here](src/containers/Home/index.jsx);
- [Why Formik?](https://jaredpalmer.com/formik/docs/overview#motivation)
- [Why Axios?](https://github.com/axios/axios#features)
- [Why Material?](https://material-ui.com/blog/material-ui-v4-is-out)
## :open_file_folder: 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.
## :scroll: License
The MIT License (MIT)
[Copyright (c) Feross Aboukhadijeh](https://github.com/standard/eslint-config-standard)
[Copyright (c) 2012 Airbnb](https://github.com/airbnb/javascript)
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.