Aceblock OIDC client npm package

This is opesource project of npm package from Aceblock, to help you easilly protect your web application.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgements

About The Project

New tehnologies are comming and with them new possibillities, so here we are working on self sovereign identity, for enabeling end users to create their own identiti and with that to give them oportunity to gain controll over personal data (age, contact data, hobbies, ect.).

This project is just tiny part of the whole structure and enables businessess to easily implement register and login of the potential customer into their web portals. At the same tame it makes it easi to implement authentication an authorisation of customers on any web app endpoint.

Here's how login and register works for user:

• User installs our Aceblock IDentity app on their mobile phone and creates their identity by entering their data
• Business creates Aceblock IDentity for their domain/web portal
• Business installs aceblock-OIDC-client npm package and enters formerly created ID (detaild instructions for implementing are [here][instalation instructions])
• User opens businesses login/register page -> qr code shows -> user scans qr code with his web app and confirms connection and Voilà - User is registered and loged in to the web portal - web page automaticaly redirects from login page to user page

Built With

This section should list any major frameworks that you built your project using. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.

• JavaScript
• NPM
• ExpressJS
• ...

Getting Started

This are instruction how to set up you project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

Befor you start setting up the project you need to install:

• npm

  npm install npm@latest -g

Installation

1. Get a free API Key at https://example.com
2. Clone the repo

   git clone https://github.com/your_username_/Project-Name.git

3. Install NPM packages

   npm install

4. How to implement this project is more detailed described here - actual implemetation in step 5.

Usage

How to use this project is more detailed described here.

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

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

Contact

Gregor Sajovic - @aceblockcom - gregor.sajovic@netis.si

Project Link: https://github.com/aceblockID/aceblock-OIDC-client

Acknowledgements

instalation instructions