@sun-asterisk/tech-standard-reactjs-auth v1.0.0

React.js Auth Module

The module auth for React.js.

What is React.js Auth module ?

Authentication is an important aspect of any web application that involves user accounts and sensitive data. In ReactJS, there are several libraries and modules available that help you implement authentication in your application.

One such module is React.js Auth Module for ReactJS. This module provides a simple way to add user authentication to your React application. It follows industry-standard security practices like using JSON Web Tokens (JWTs), HTTPS, and cookies to ensure secure and reliable user authentication.

The authentication module for ReactJS provides a set of components and utilities that handle authentication-related tasks like sign in, sign out, sign up, and refresh token. With this module, you can easily integrate authentication into your React application and ensure that your users' data and privacy are protected.

Documentation

Please read the Wiki Documentation.

Installation

Add the package @sun-asterisk/tech-standard-reactjs-auth dependency to your project:

• With npm:

npm install --save @sun-asterisk/tech-standard-reactjs-auth

• With yarn:

yarn add @sun-asterisk/tech-standard-reactjs-auth

Usage

Here is example code for loginFn, registerFn and logoutFn

loginFn

import { useState } from 'react';
import { loginFn } from 'tech-standard-reactjs-auth';

export const SignInPage = () => {
  const [username, setUsername] = useState('');
  const [passwd, setPasswd] = useState('');

  return (
    <>
      Not signed in <br />
      <button onClick={() => loginFn({ username, passwd })}>Login</button>
    </>
  )
}

registerFn

import { useState } from 'react';
import { registerFn } from 'tech-standard-reactjs-auth';

export const SignOnPage = () => {
  const [username, setUsername] = useState('');
  const [email, setEmail] = useState('');
  const [passwd, setPasswd] = useState('');

  return (
    <button onClick={() => registerFn({ username, email, passwd })}>Register</button>
  )
}

logoutFn

import { logoutFn } from 'tech-standard-reactjs-auth';

export const HomePage = () => {
  return (
    <button onClick={() => logoutFn()}>Logout</button>
  )
}

How to contribute

Create a issue on Github

• Step 1: Go to repository, click on issue tab

• Step 2: Choose new issue then depend on what kind of issue you have, chose create bug or request a feature

• Step 3: Fill data into template and click Submit new issue

Create a pull request on Github

• Step 1: Go to repository, click on pull request tab

• Step 2: Pull repository to local using git clone or download zip file.

• Step 3: In your local, create new branch and add code that you want to contribute

• Step 4: Add commit and push to correct remote (use git remote -v to check list remote)

• Step 5: Go to repository, choose compare & pull request

• Step 6: Fill data in template and choose Create pull request

License

Apache2 License - Copyright (c) 2022, Sun*