Skip to content

Latest commit

 

History

History
115 lines (92 loc) · 5.3 KB

README.md

File metadata and controls

115 lines (92 loc) · 5.3 KB
Raw

Firebase React Admin Biolerplate
incl. GitHub Actions deployment

Firebase React Admin Biolerplate is a project template (aka, boilerplate) for building modern, scalable web applications with React using serverless infrastructure provided by Google Firebase. It allows you to save time and build upon a solid foundation and design patterns.

This project was bootstrapped with Create React App.

Tech Stack

  • Create React App (★ 76k) for development and test infrastructure (see user guide)
  • Material UI (★ 54k) to reduce development time by integrating Google's Material Design
  • React Dashboard (★ 2k) Free React Dashboard made with Material UI’s components
  • Reach Router (★ 6k) for declarative routing and client-side navigation
  • React Dropzone (★ 7k) Simple React hook to create a HTML5-compliant drag'n'drop zone for files.
  • TypeScript (★ 58k) TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
  • Google Cloud & Firebase for serverless architecture - Cloud SQL, Cloud Functions, CDN hosting, file storage (docs)

Also, you need to be familiar with HTML, CSS, JavaScript (ES2015), TypeScript and React.

Prerequisites

Getting Started

Just clone the repo, update environment variables in .env and/or .env.local file, and start hacking:

$ git clone [email protected]:nightillusions/react-firebase-material-admin.git MyApp
$ cd MyApp
$ yarn                             # Installs dependencies
$ yarn start                       # Compile the app and opens it in a browser with "live reload"

Then open http://localhost:3000/ to see your app.

npm start

How to Deploy

For more information refer to the Deployment guide in the project's Wiki.

How to Update

If you keep the original Git history after cloning this repo, you can always fetch and merge the recent updates back into your project by running:

$ git remote add frab [email protected]:nightillusions/react-firebase-material-admin.git
$ git checkout master
$ git fetch frab
$ git merge frab/master
$ yarn install

_NOTE: Try to merge as soon as the new changes land on the master branch in the upstream repository, otherwise your project may differ too much from the base/upstream repo.

License

Copyright © 2020 Pascal Jordin. This source code is licensed under the MIT license found in the LICENSE.txt file.

Made with ♥ by Pascal Jordin (website) Get in touch!