|
1 | 1 | # AuthKit |
| 2 | + |
2 | 3 |  |
3 | 4 |  |
4 | | - |
5 | | - |
6 | | - |
| 5 | + |
| 6 | + |
| 7 | + |
| 8 | + |
| 9 | +AuthKit is a reusable, configuration-driven authentication package for Laravel applications. |
| 10 | + |
| 11 | +It provides a complete authentication system with Blade-based UI, flexible configuration, and extensible flows — without forcing a fixed implementation. |
| 12 | + |
| 13 | +--- |
| 14 | + |
| 15 | +## 🚀 Documentation |
| 16 | + |
| 17 | +Full documentation is available here: |
7 | 18 |
|
8 | | -Reusable Laravel auth kit package with Blade UI, themes, email verification, two-factor authentication, password reset, and rate limiting. |
| 19 | +👉 **https://xultech-ltd.github.io/auth-kit/** |
9 | 20 |
|
10 | | -## Status |
| 21 | +The documentation covers: |
11 | 22 |
|
12 | | -AuthKit is currently in active development and not yet published to Packagist. |
| 23 | +- Installation |
| 24 | +- Configuration |
| 25 | +- Authentication flows |
| 26 | +- UI customization |
| 27 | +- Extensibility and overrides |
| 28 | +- Security features |
13 | 29 |
|
14 | | -## Features |
| 30 | +--- |
15 | 31 |
|
16 | | -- Login / registration |
17 | | -- Email verification (link or token) |
18 | | -- Password reset (link or token) |
19 | | -- Two-factor authentication(TOTP supported - able to extend) |
| 32 | +## ✨ Features |
| 33 | + |
| 34 | +- Authentication (login & registration) |
| 35 | +- Email verification (link or token-based) |
| 36 | +- Password reset (link or token-based) |
| 37 | +- Two-factor authentication (TOTP, extensible drivers) |
20 | 38 | - Blade-based UI components |
21 | | -- Theme support |
22 | | -- Rate limiting configuration |
23 | | -- Controller and validation overrides |
| 39 | +- Theme and UI customization support |
| 40 | +- Fully configuration-driven architecture |
| 41 | +- Route, controller, and validation overrides |
| 42 | +- Rate limiting and security controls |
| 43 | + |
| 44 | +--- |
| 45 | + |
| 46 | +## 📦 Installation |
| 47 | + |
| 48 | +> ⚠️ AuthKit is currently in active development. |
| 49 | +
|
| 50 | +Once published: |
| 51 | + |
| 52 | +```bash |
| 53 | +composer require xul/auth-kit |
| 54 | +``` |
| 55 | +Then follow the installation guide in the documentation. |
| 56 | + |
| 57 | +## ⚙️ Configuration Philosophy |
| 58 | + |
| 59 | +AuthKit is built around a configuration-first approach. |
| 60 | + |
| 61 | +Instead of hardcoding behavior, you can control: |
| 62 | + |
| 63 | +- authentication flows |
| 64 | +- route structure and naming |
| 65 | +- validation and payload mapping |
| 66 | +- UI rendering and form schemas |
| 67 | +- security features (verification, 2FA, confirmations) |
| 68 | +- frontend behavior and themes |
| 69 | + |
| 70 | +This allows you to adapt AuthKit to your application without modifying package internals. |
| 71 | + |
| 72 | +## 🧪 Testing |
| 73 | +```bash |
| 74 | +composer test |
| 75 | +``` |
| 76 | + |
| 77 | +## 🤝 Contributing |
| 78 | + |
| 79 | +Contributions are welcome. |
| 80 | + |
| 81 | +Please: |
| 82 | +- open issues for bugs or feature requests |
| 83 | +- submit pull requests for improvements |
| 84 | +- follow existing code style and structure |
| 85 | + |
| 86 | +- ## 📄 License |
| 87 | + |
| 88 | +AuthKit is open-sourced software licensed under the MIT license. |
0 commit comments