Skip to content

onedionys/onedionys-user-authentication

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Welcome to One Dionys - User Authentication! 👋

A component for managing user authentication in web applications. 💖

💾 Requirements

  • Web Browser - Can be used as an emulator to build applications. Example [Chrome, Firefox, Safari & Opera].
  • Internet - Because many use CDN and to make it easier to find solutions to all problems.

🎯 How To Use

Example Syntax

const UserAuthentication = require('./src/user-authentication');

// Initialize User Authentication
const auth = new UserAuthentication();

// Register a new user
auth.register('username', 'password');

// Authenticate user credentials
const isAuthenticated = auth.authenticate('username', 'password');
console.log('User authenticated:', isAuthenticated);

// Logout user
const isLoggedOut = auth.logout('username');
console.log('User logged out:', isLoggedOut);

Explanation

  • register(username, password): Registers a new user with the provided username and password. Returns true if registration is successful, false if the username already exists.
  • authenticate(username, password): Authenticates user credentials. Returns true if authentication is successful, false otherwise.
  • logout(username): Logs out the user with the given username. Returns true if logout is successful, false if the user is not found.

Return Value

  • register(username, password): Returns true if user registration is successful.
  • authenticate(username, password): Returns true if user authentication is successful.
  • logout(username): Returns true if user logout is successful.

📆 Release Date

  • v1.0.0 : 07 March 2024
  • v1.0.1 : 11 March 2024
  • v4.0.0 : 11 March 2024
  • v4.0.1 : 13 March 2024
  • v4.0.2 : 18 March 2024
  • v5.0.0 : 31 March 2024

🧑 Author

📝 License

  • Copyright © 2024 One Dionys
  • One Dionys - User Authentication is an open source project licensed under the MIT license

☕️ Suppport & Donation

Love One Dionys - User Authentication? Support this project by donating or sharing with others in need.

Made with ❤️ One Dionys