README.md

xBurger

Online burger ordering app created with React.
View Demo
https://react-xburger.web.app/

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Contact
4. Acknowledgements

About The Project

This was created while learning React.js from a Udemy course (React - The Complete Guide (incl Hooks, React Router, Redux).

I have learned:

• React JSX
• Class and function components
• Lifecycle methods
• React Router
• React Hooks
• Redux
• Jest
• Enzyme

Built With

• React
• Redux
• React Router

Getting Started

Prerequisites

• npm

  npm install npm@latest -g

Installation

1. Get a free API Key for Firebase authentication.
2. Clone the repo

   git clone https://github.com/iamsanjaymalakar/react-xburger.git

3. Install NPM packages

   npm install

4. Setup your firebase authentication API key in file src/store/actions/auth.js.

   const API_KEY = 'FIREBASE_AUTH_API_KEY';

5. Setup your firebase database URL in src/axios-orders.js/. Store a JSON in your database with key ingredients.

   "ingredients" = {
       "bacon":0,
       "cheese":0,
       "meat":1,
       "salad":0
   }

6. Firebase database rules:

   {
   "rules": {
       "ingredients": {
           ".read": "true",
           ".write": "true"
       },
       "orders": {
           ".read": "auth != null",
           ".write": "auth != null",
           ".indexOn" : ["userId"]
       }
   }

7. Run the project using npm.

   npm start

Contact

Sanjay Malakar - @19malakar - [email protected]

Project Link: https://github.com/iamsanjaymalakar/react-xburger

Acknowledgements

• Udemy React course by Maximilian Schwarzmüller