Giter Club home page Giter Club logo

juggernaut's Introduction

Netlify Status

Juggernaut

An unstoppable boilerplate

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


Gif by Reuno

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

or via yarn:

yarn

Start server

npm run start

or

yarn start

Patterns

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

  • NPM or Yarn? Your call.
  • 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

Project structure

  • src/assets: Static files (images, fonts and icons);
  • src/components: Components of React to be shared and reused in the project;
  • src/commons: 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.

References

This project was bootstrapped with Create React App.

License

The MIT License (MIT)

Copyright (c) Feross Aboukhadijeh

Copyright (c) 2012 Airbnb

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.

juggernaut's People

Contributors

vilaboim avatar marlonmleite avatar stanleygomes avatar mkny avatar rafael1995 avatar faelribeiro22 avatar humbss avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.