Skip to content

Commit 255dd9b

Browse files
committed
docs: improve existing documentation
1 parent 8c94507 commit 255dd9b

File tree

5 files changed

+30
-6
lines changed

5 files changed

+30
-6
lines changed

β€ŽREADME.mdβ€Ž

Lines changed: 30 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,22 +10,46 @@ A simple CRUD web project for user management.
1010
Leave `XAMPP` up and running after its installation.
1111

1212
## Database
13-
The database requires to be manually setup for this project.
14-
- Access `phpMyAdmin` through `XAMPP` control panel and select the SQL tab.
13+
The database needs to be manually set up for this project.
14+
- Access `phpMyAdmin` through the `XAMPP` control panel and select the SQL tab.
1515

16-
- Copy the `ddl.sql` file located in the root of this project and paste it at the query box then click on `Execute`.
16+
- Copy the contents of the `ddl.sql` file located in the root of this project and paste it into the query box, then click on `Execute`.
1717

18-
- Rename the `.env.example` file to `.env`, set your own values to the variables if required.
18+
- Rename the `.env.example` file to `.env` and set your own values for the variables if required.
1919

2020
## Installation
2121
Download the project by visiting the [releases page](https://github.com/PoweredTable/php-user-management/releases) of this repository and unzip the file, or you could also simply clone it.
2222

23-
To work with `XAMPP`, ensure the project will be located at `XAMPP` folder installation, e.g. `C:\xampp\htdocs`.
23+
To work with `XAMPP`, ensure the project is located in the `XAMPP` installation folder, e.g. `C:\xampp\htdocs`.
2424

2525
Inside the project folder, install the required dependencies using `Composer`.
2626
```bash
2727
composer install
2828
```
2929

3030
## Usage
31-
Access the web page through http://localhost/php-user-management.
31+
Access the web page through http://localhost/php-user-management. You should see the homepage below if the installation was done correctly.
32+
33+
![](/docs/img/homepage.jpeg)
34+
35+
Click on the **NEW USER** button. A modal will appear asking for user data input.
36+
37+
![](/docs/img/user%20form.jpeg)
38+
39+
You must fill the form with the user **name**, **e-mail**, **phone** and a **photo**, which must be uploaded.
40+
41+
The **photo** must be a `.JPG`, `.JPEG` or `.PNG` file, other file extensions are not supported.
42+
43+
![](/docs/img/filled%20user%20form.jpeg)
44+
45+
After clicking on **Save changes** you'll see an HTML alert box displaying whether the request was successfull or not.
46+
47+
A successful request will refresh the page, and the newly added user will appear.
48+
49+
![](/docs/img/homepage%20with%20user.jpeg)
50+
51+
You can also update or delete the user shown on the homepage. Click on the yellow 'U' button to update or the red 'D' button to delete.
52+
53+
---
54+
55+
Made with πŸ’œ  by Lucas da Silveira πŸ‘‹
49.8 KB
Loading
44.9 KB
Loading

β€Ždocs/img/homepage.jpegβ€Ž

27.6 KB
Loading

β€Ždocs/img/user form.jpegβ€Ž

42.7 KB
Loading

0 commit comments

Comments
Β (0)