jikalvin / starter

Firebase and react starter

React & Firebase Starter

Tech Stack

• Firebase - Firestore database, auth, cloud functions, local emulators
• React
• Webpack
• Tailwind CSS
• React Router
• react-firebase-hooks
• React Helmet - SEO
• Mocha - testing for Firebase
• ESLint - based on AirBnB config

Prerequisites

You will need the following to use this starter:

• Node
• Java DK
• A Firebase project created in Firebase Console
• Install Firebase CLI tools: npm install -g firebase-tools

Setup Guide

Clone this repo: git clone https://github.com/codebusters-ca/react-firebase-starter.git

Go to the Firebase project directory, run the setup script and follow the prompts: cd .\react-firebase-starter\ && npm run setup

Usage

Run Firebase Emulators with npm run emulators.

In another terminal, launch the app with npm start. The app will run on localhost:3000.

If the setup process was successful, you will see Hello from Firestore Emulator in the app.

Build

npm start

Test

npm run emulators In another terminal: npm test

You should see a list of 3 tests that all pass.

Deploy

npm run build

Loom Video

Video demo

Contribute

We ❤️ feedback and help from fellow devs! Check out open issues, create a new one, or send us a pull request.

Licence

This project is licensed under the MIT license.