Skip to content

Latest commit

 

History

History
119 lines (82 loc) · 3.93 KB

README.md

File metadata and controls

119 lines (82 loc) · 3.93 KB
Raw

Mobile Authentication System

This is an authentication template for apps built with Ionic and Firebase.

The idea is to have a fully functional authentication starter template, we're still thinking through the features it should have, but for now this is what we're thinking:

  • Email & Password Traditional Authentication.
  • Google SSO.
  • Anonymous Authentication.
  • Passwordless Authentication (For the web version and need to check availability for the native app).
  • Another form of 3rd party authentication (Github, Twitter, Facebook?).
  • The "Forgot your password?" workflow.
  • A profile page for the user to edit their data. (Or add new authentication workflows).

Currently Working on

  • Email and Password Authentication
    • Create the Email Authentication Service.
    • Create the Landing Page.
    • Create the Login Page
    • Create the Signup Page.
    • Create the Password Reset Page.
    • Create the Authentication Guard.
    • Protect Internal Routes with the AuthGuard.
    • Create documentation for the email & password authentication module.
  • Anonymous Authentication.
    • Enable Anonymous Authentication.
    • Enable feature to link an anonymous account to a "full" account.
  • Social Authentication.
    • Think about which social providers are going to be included in the app.

Installation

There's no straightforward way to install 3rd party templates from the Ionic CLI, so the best way to 'install' this template would be to copy the project and run npm install.

For that, open your terminal, navigate to the folder you keep your projects and type:

git clone [email protected]:YuxiGlobal/ionic-firebase-authentication.git

Once it's done cloning the project, navigate to the project's folder and run npm install.

cd ionic-firebase-authentication
npm install

Usage example

PENDING

The idea is to keep all the documentation inside the docs/ folder.

Capacitor

We're going to be using Capacitor as a replacement for Cordova. Capacitor isn't enabled by default, so there are a few things we need to do. Open your terminal and type:

ionic integrations enable capacitor

When it's done, make a build of your project:

ionic build

It will generate the build inside the www/ folder. Now you can add the platforms (remember that you need a Mac with XCode installed to build for iOS)

ionic cap add android
ionic cap add ios

And lastly, we need to sync everything inside the www/ in our app platforms:

ionic cap sync

Release History

  • 0.0.1
    • Work in progress

Meta

This project is maintained by Yuxi Global, if you have any questions you can get in touch with

Jorge Vergara – @javebratt – [email protected]

Distributed under the MIT license. See LICENSE for more information.

https://github.com/javebratt

Contributing

First of all, thank you for the help :-)

Best way to contribute (with new features, bug fixes, typo fixes, etc) is to:

  1. Fork the repo (https://github.com/YuxiGlobal/ionic-firebase-authentication/fork)
  2. Create your feature branch (git checkout -b feature/fooBar)
  3. Commit your changes (git commit -am 'Add some fooBar')
  4. Push to the branch (git push origin feature/fooBar)
  5. Create a new Pull Request