Package Exports
- pwa-auth
- pwa-auth/source/development/pwa-auth
- pwa-auth/source/esm/pwa-auth
Readme
Progressive Website Application - Authentication
Jack's Publishing maintains Custom HTML Elements where developers can focus on UX rather than low-level API calls.
Visit the Live Demo
pwa-auth.js is a bundle of 5 Custom HTML Elements for Firebase (IAM) Authenication using email and password, with the ability to change username, icon, email, password, or delete your own account and it's content all together.
pwa-auth.js (Authentication Webcomponents) are for anyone who is looking for a quick and simple way to sign-up, log-in, log-out, modify, or delete a firebase account information from thier own personal domain.
You will learn how to place 5 Custom HTML Tags, reference CSS, and How to Initialize an Firebase Instance. By either Standard or Modular ECMA Script.
Continue reading to understand how to install this project:
Prerequisites
- Google:
- Google Analytics
- Firebase Project
- Firebase:
- Authentication - email login
- Cloud Storage - storage bucket
Technical Summary
- Type Strong with TypeScript
- Stylable with CSS Custom Properties
- State Management with ReduxJS
- Authentication Google's Firebase
- Firebase Initialization Object:
window.process = { env: { FIREBASE_CONFIG:
Prototypes
<user-icon><user-drawer><user-login><user-settings><email-reset>
Features: Library Logical States
- Register through Email and Password
- Log-in
- Log-out
- Change Username
- Change Email
- Change Password
- Upload Profile Picture
- Delete Account
- Development:
- Global Functions
- Redux State Connection
Elements
- Button:
- Email Log-in / Email Subscribe / Icon
- Drop-down Drawer:
- Email Log-in / Email Subscribe / Menu with Log-out
- Pages:
- Account Settings
- Auth: Email Log-in / email Subscribe
- Password Reset
Project Type: ECMA Script Modules
Eports: classes and objects
// Custom HTML Elements
import 'pwa-auth';
// <user-icon subscribe emptyArtwork="./images/empty.jpg"></user-icon>
// <user-drawer subscribe settingsURL="./settings"></user-drawer>
// <user-settings emptyArtwork="./images/empty.jpg"></user-settings>
// Firebase Objects
import { db, storage, auth, user } from 'pwa-auth';
// db - firestore database reference
// storage - firebase storage reference
// auth - user object reference
// user - active user boolean reference
// Firebase-Redux States
import { store } from 'pwa-auth';
// store.verified
// store.userId
// store.name
// store.email
// store.photoURLProject Type: Global Namespaces
<!-- Optional: Copy the Project Files from 'src' Folder -->
<script type="module" src="./pwa-auth.js"></script>HTML Webcomponents
<user-icon>
<!-- property: subscribe: (Initial State): Subscribe -->
<!-- property: subscribe: else (Initial State): Login -->
<!-- property; empty: location of empty image -->
<!-- state: Logged-out: txt: Login Button -->
<!-- state: Logged-out: txt: Subscribe Button -->
<!-- state: Logged-in: photo: Icon Button -->
<user-drawer>
<!-- feature: Top-down drawer: 1.4 seconds -->
<!-- property: url: location of <pwa-settings> Tag -->
<!-- property: subscribe: (Initial State): Subscribe -->
<!-- property: subscribe: else (Initial State): Login -->
<!-- state: logged-out: Sign-up by Email Addresses and Password -->
<!-- state: logged-out: Sign-in by Email Addresses and Password -->
<!-- state: logged-in: Settings Page Link, Log-out Button -->
<user-login>
<!-- feature: regular visible page component -->
<!-- state: logged-out: Sign-up by Email Addresses and Password -->
<!-- state: logged-out: Sign-in by Email Addresses and Password -->
<!-- state: logged-in: content: <slot></slot> -->
<user-settings>
<!-- 1 Photo Upload Feature, view uploaded bucket of photos, photo ediotr -->
<!-- empty property: location of empty image -->
<!-- Unavailable Photo -->
<!-- Update Username -->
<!-- Update Email / Verify -->
<!-- Update Password -->
<!-- Delete Account, Photos, Information -->
<email-reset>
<!-- Coming Soon -->:root() { --pwa_design_settings: ... ; }
- Optional: Custom CSS PropertiesBoilerplate
For HTML projects, copy js bundle to disk
- source/esm/
- pwa-auth.js
- pwa-auth.js.map
- pwa-styles.css
- empty.jpg
<head>
<!-- Optional - CSS Custom Variables-->
<link type="stylesheet" href="./path_to/pwa-styles.css">
<!-- Required - Configure Firebase Instance -->
<script>
window.process = { env: { FIREBASE_CONFIG: JSON.stringify({
apiKey: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
authDomain: "xxxxxxx.xxxxxxx.xxx",
databaseURL: "https://xxxxxxx.xxxxxxx.xxx",
projectId: "xxxxxxx",
storageBucket: "xxxxxxx.xxxxxxx.xxx",
messagingSenderId: "xxxxxxxxxxx",
appId: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
measurementId: "xxxxxxxxxxx"
})
}
};
if (lolalhost) { window.process = { env: { FIREBASE_CONFIG: 'etc.' } } }
</script>
<!-- Webcomponent Library -->
<script type="module" src="./path_to/pwa-auth.js"></script>
</head>Implementation - Drawer
<body>
<header>
<user-icon subscribe empty="./images/empty.jpg"></user-icon>
</header>
<user-drawer subscribe url="./settings"></user-drawer>
<main>
<user-settings empty="./images/empty.jpg"></user-settings>
</main>
</body>Implementation - Page
<body>
<header>
<user-icon empty="./images/empty.jpg" subscribe ></user-icon>
</header>
<main>
<user-login subscribe ></user-login>
<user-settings empty="./images/empty.jpg"></user-settings>
</main>
</body>CSS Custom Properties
/* <user-icon> --> <button> */
:root {
--pwa_icon_background_color: #6cc04a;
--pwa_icon_radius: 6px;
--pwa_icon_border: 2px solid black;
--pwa_icon_padding: 0px 16px;
--pwa_icon_hover_color: lightgrey;
--pwa_icon_font: 'Arial', sans-serif;
--pwa_icon_height: 32px; /* state: Logged-out (sync) */
--pwa_icon_diameter: 32px; /* state: Logged-in (sync) */
}
/* <user-drawer> */
:root {
--pwa_drawer_background_color: #fff;
--pwa_drawer_border-radius: 20px;
--pwa_drawer_border: 3px #303030 solid;
--pwa_drawer_z-index: 2;
--pwa_drawer_text_color: #303030;
}
/* <user-settings> */
:root {
--pwa_settings_background_color: grey;
--pwa_nav_button_color: grey;
--pwa_nav_highlight_color: black;
--pwa_divider_color: grey;
--pwa_header_color: black;
--pwa_input_background_color: #E1E5EB;
--pwa_label_text_color: black;
--pwa_button_text_color: #fff;
--pwa_button_background_color: #6cc04a;
--pwa_button_border_color: #60b23e;
}
/* shared core elements */
:root {
--section_background_color: white;
}Global Namespaced Firebase Instance Configuration
pwa-auth.js is built upon the Firebase SDK (Software Development Kit). The entire bundle is one instance of firebase that takes in the configuration information, internally.
Project Bundles
import './pwa-auth/source/development/pwa-auth';
import './pwa-auth/source/esm/pwa-auth';Technological Engineering
- Development (Server-side) Environment: Node JavaScript
- Backend: Google Cloud: Firebase
- Predicate State Behavior: Redux
- Frontend (Client-side): Lit
Feedback
All feedback, comments, bugs, and requests are welcome.