Skip to content

Commit a1502a0

Browse files
authored
Update README
1 parent 012a4a4 commit a1502a0

File tree

1 file changed

+55
-2
lines changed

1 file changed

+55
-2
lines changed

README.md

Lines changed: 55 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,55 @@
1-
# codeigniter4-auth-and-user-management
2-
Codeigniter 4 Login and User Management
1+
# About Codeigniter 4 Authentication and User Management System
2+
A simple authentication and user management system for CodeIgniter 4
3+
4+
Benefits:
5+
6+
- Pre-built Dashboard page
7+
- Pre-built Account page
8+
- Pre-built Profile page
9+
- Pre-built Settings page
10+
- User login, User registration, Recover password functions
11+
- User acess logs for tracking
12+
- User Management: Register, Modify, and Delete users
13+
14+
15+
Codeigniter 4 Auth and User management provides complete basic authentication system, account viewing, profile editing, and dashboard viewing.
16+
17+
## Getting started
18+
19+
### Installation
20+
21+
1. Download or clone the repo to your desktop.
22+
2. Change directory `cd my-app`
23+
3. Import `my-app/database.sql` to your MySQL or MariaDB Server, create a user and grant all rights to the imported `DB`
24+
4. Rename `.env.example` to `.env`
25+
5. Change the App url to `app.baseURL = 'http://localhost/my-app/public/'`
26+
6. Update database config, change the lines at `database.default.database =`, `database.default.username =`, `database.default.password`, and `database.default.hostname =` in .env file.
27+
7. Run `php spark serve` to open live application.
28+
8. Alternatively, you can browse the app using a web browser, enter this URL address `http://localhost/my-app/public`.
29+
9. Login using sample account usernaeme `[email protected]`, password `admin`
30+
31+
### System Requirements
32+
33+
1. `PHP` >= 7.1.3
34+
2. `MySQL` 5.x or newer versions
35+
3. `Nginx` or `Apache` (recommended) http server
36+
4. Required PHP extensions: `OpenSSL`, `PDO`, `Mbstring`, `Tokenizer`, `Ctype`, `JSON`
37+
38+
If you are running on local development, we recommend using `AMPPS` stack which has all the system requirements [Download AMPPS](https://www.ampps.com/downloads) available in Windows, Mac, Linux Installers.
39+
40+
## Screenshots
41+
![PHP Attendance Management System - Manager Dashboard](https://i.postimg.cc/5NbGZpJY/manager-dashboard.png)
42+
43+
## Contributing
44+
45+
Thank you for considering contributing to the Codeigniter 4 Auth and User management!
46+
47+
## Security Vulnerabilities
48+
49+
If you discover a security vulnerability within Codeigniter 4 Auth and User management, please submit a pull request. All security vulnerabilities will be promptly addressed.
50+
51+
## License
52+
53+
The Codeigniter 4 Auth and User management is open-source software licensed under the [Apache license 2.0](http://www.apache.org/licenses/LICENSE-2.0).
54+
55+
Copyright (c) 2020-present, Alexis Luna

0 commit comments

Comments
 (0)