Code Monkey home page Code Monkey logo

bhattiasad99 / react-firebase-boilerplate Goto Github PK

View Code? Open in Web Editor NEW
3.0 1.0 2.0 341 KB

Get started quickly on your next React JS project with this boilerplate build on Atomic Design Pattern that includes protected routing, common dependencies and packages, such as Material UI components (MUI), Firebase integration, and Redux state management. Includes example components and utilities to help you jumpstart your development

HTML 7.49% JavaScript 91.63% CSS 0.88%
atomic atomic-design authentication boilerplate boilerplate-application boilerplate-template css-in-js frontend jss material-ui

react-firebase-boilerplate's Introduction

React JS Boilerplate

Introduction

This is a React JS boilerplate build using Atomic Design Principals that you can use as a starting point for your applications. It includes some common dependencies and packages that you may want to use in your projects, as well as some example components and utilities.

Features

  • Out of the box Firebase Integration
  • Material UI v5
  • Protected Routing
  • Professional Folder Structure

Dependencies

This boilerplate includes the following dependencies:

@emotion/react and @emotion/styled for CSS-in-JS styling @mui/icons-material and @mui/material for Material UI components @reduxjs/toolkit and react-redux for Redux state management firebase for Firebase integration notistack for displaying notifications react-quill for a rich text editor react-router-dom for client-side routing

Getting Started

To get started with this boilerplate, clone this repository to your local machine and install the dependencies using npm install.

Installing dependancies

Copy code git clone https://github.com/your-username/your-boilerplate.git cd your-boilerplate npm install To start the development server, run npm start.

Applying environment variables

Locate the file named .env.example and rename it to .env

Starting the server

Copy code npm start This will start the development server on http://localhost:3000 and open a browser window with your application.

Building for Production

To build your application for production, run npm run build. This will create a production-ready build in the build directory.

Copy code

npm run build You can then deploy this build to a static hosting provider, such as Netlify or Firebase Hosting.

Contributing

If you find a bug or want to suggest a new feature, please open an issue on GitHub. Pull requests are also welcome!

react-firebase-boilerplate's People

Contributors

bhattiasad99 avatar

Stargazers

 avatar  avatar  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.