Skip to content

JasonHoku/MicroHawaii

Repository files navigation

OpenSource E-Commerce & Web Management Tool

Strapped with Googles Firebase for Free 10GB App Developments

Firebase Badge PayPal Badge EmailJS Badge CodeQL Badge ESLint Badge Analytics Badge Image Upload Badge Admin Panels Badge  WYSIWYG Design Tools Badge

GitHub license npm version PRs Welcome

Visits Badge Created Badge Commits Badge Discord

The Expertly Crafted Web Dev Utility

image

A.) Documentation

Index Of The Following Readme:

A.) Documentation

====

B.) Setup

B4.) For More Info On React Apps

====

C.) Going Live

C1.) Firebase

C2.) PayPal

C3.) EmailJS

C4.) Google Analytics

====

You can find the React documentation on the website.

Check out the Getting Started page for a quick overview.

B.)Setup

Install Prerequisites:

NodeJS: https://nodejs.org/en/

git: https://git-scm.com/downloads

B2.)Download Source Files & Initialise Workspace.

B3.) Download source with git:

Type into git bash in the desired setup directory (git install prequisite):

git clone https://github.com/JasonHoku/MicroHawaii

Now you have the source code and may edit and run it as a React app with:

npm i npm start

B4.) For More Info On React Apps:

You can find the React documentation on the website.

Check out the Getting Started page for a quick overview.

C.) Going Live

This section is for integrating your own: PayPal, Email Notifier, Google Analytics and Firebase App.

Find example.env in your project root directory and rename it to .env This file is set to be auto excluded in sharing and will be your passwords and keys file.

None of these tools are required to run the app locally or from your choice of computer.

Put API Keys into example.env slot and rename example.env to .env (then restart app)

C1.) Firebase

Used For Hosting Your App

  • Free .firebaseapp.com AND .web.app domain suffixes.
  • Free 10GB of Hosting (15,000 HD Images)
  • Free 50,000 Database Writes Per Day (Best In Industry Quota)

Again, not necessary but very useful for launching your application quickly, easily and affordably (Free) to the world wide web.

Signup and Install firebase tools

npm i firebase-tools

Sign in and init project:

firebase init

then possible scripts are:

npm run femu - Start React Frontend + Firebase Backend npm run fb - Build CRA and Deploy Everything To Live npm run fbh - Build CRA and Deploy Only Hosting (excludes functions and saves minutes)

C2.) PayPal

https://developer.paypal.com/

Create a Live Production API Key (Important that it's a Live key)

C3.) EmailJS

Email Notification Tool

Signup and get API keys from Settings

C4.) Google Analytics

This app is strapped to send details on every click to Google Analytics. Amazingly powerful for disovering how users are utilizing your web app.

https://analytics.google.com/

Settings and stats found in Firebase Console.

Accepting PRs, questions, comments and concerns.