Skip to content

Commit a49f12d

Browse files
committed
📝 README improval and screenshots
1 parent 7cf5c2d commit a49f12d

File tree

7 files changed

+37
-4
lines changed

7 files changed

+37
-4
lines changed

README.md

Lines changed: 37 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,37 @@ For a better developer experience :
5252

5353
## 📸 Screenshots
5454

55-
[Click here](/docs/screenshots.md) to preview the application once launched
55+
_Click on each arrow to see the screenshots :_
56+
57+
<details>
58+
<summary>Home page (dark)</summary>
59+
<img src="docs/images/home-page.png" alt="Home Page (dark)">
60+
</details>
61+
62+
<details>
63+
<summary>Home page (light)</summary>
64+
<img src="docs/images/home-page-lightMode.png" alt="Home page (light)">
65+
</details>
66+
67+
<details>
68+
<summary>Home page (mobile)</summary>
69+
<img src="docs/images/home-page-mobile.png" alt="Home page (mobile)">
70+
</details>
71+
72+
<details>
73+
<summary>Error page</summary>
74+
<img src="docs/images/error-page.png" alt="Error Page">
75+
</details>
76+
77+
<details>
78+
<summary>Login page</summary>
79+
<img src="docs/images/login-page.png" alt="Login Page">
80+
</details>
81+
82+
<details>
83+
<summary>Register page</summary>
84+
<img src="docs/images/register-page.png" alt="Register Page">
85+
</details>
5686

5787
<br>
5888

@@ -77,8 +107,9 @@ yarn install
77107
pnpm install
78108
```
79109

80-
### 3. Database
110+
### 3. Database Setup
81111

112+
This template uses a database for the authentication of next-auth.
82113
Create the MySQL/MariaDB database and insert the database URL in the **.env** file.<br>
83114

84115
![](https://i.imgur.com/ALeKvsf.png 'Creating a database on phpMyAdmin')
@@ -118,9 +149,9 @@ Now open [http://localhost:3000](http://localhost:3000) with your favorite brows
118149

119150
## 📄 Documentation
120151

121-
- [Configuration](/docs/CONFIGURATION.md) : Guide for getting the **.env** values
152+
- [Configuration](/docs/CONFIGURATION.md) : Guide for getting the values for the **.env** file
122153
- [Cleaning](/docs/CLEANING.md) : Files to remove to be ready to code
123-
- [Prisma migrations](/docs/prisma_migrations.md) : How to create migration files for your database
154+
- [Prisma migrations](/docs/prisma_migrations.md) : How to create and manage migration files for your database using Prisma
124155

125156
## 🛠 Scripts
126157

@@ -139,3 +170,5 @@ In development, you will mainly use `yarn dev` ; however, here are all the scrip
139170

140171
For any errors found, please contact me [here](https://discord.gg/G6WQsMQShZ) or do a pull request.
141172
This repository is licensed under the MIT License. See the `LICENSE` file ([here](LICENSE)) for more information.
173+
174+
### Made with ❤️ by [antoinemcx](https://github.com/antoinemcx) in TypeScript.

docs/images/error-page.png

55.2 KB
Loading
55.5 KB
Loading

docs/images/home-page-mobile.png

64.3 KB
Loading

docs/images/home-page.png

57.4 KB
Loading

docs/images/login-page.png

83.2 KB
Loading

docs/images/register-page.png

87.3 KB
Loading

0 commit comments

Comments
 (0)