fire-cracker/orden

A simple app full-stack application. Frontend was built using React, Scss, firebase and the backend was built using nodejs, express and firebase

Orden

Table of Contents

• Project Overview
• Features
• Dependencies
• Setup

Project Overview

Frontend was built using React, Scss, firebase and the backend was built using nodejs, express and firebase

Features

• Display all Orders.
• Update Order.

Dependencies

• Node - A Javascript runtime environment.
• React - A Javascript library for building user interfaces.
• React Testing Library - Light-weight solution for testing React components
• Firebase - Tools from Google for building app infrastructure, improving app quality, and growing your business.
• A package manager - yarn or NPM

Setup

• $ git clone https://github.com/fire-cracker/orden.git
• $ cd orden

Backend

API End Points

HTTPS	ENDPOINT	DESCRIPTION
POST	/orders	Get All Orders
POST	/orders/:orderId	Get Order Details

Installation

• $ cd server
• $ yarn install , to install dependencies
• Create .env file using the .env.sample file as a guide
• $ yarn start:dev, to start the server Once the server starts-up, you can query the api at http://localhost:8080/ using the end points stated above.

Test

• $ yarn test

Frontend

To install dependencies:

• $ cd client

$ npm install or $ yarn install

Available Scripts

In the project directory, you can run:

yarn start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

yarn test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

yarn build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!