Skip to content

Commit 2c0422b

Browse files
authored
Update README.md
1 parent 99f9565 commit 2c0422b

File tree

1 file changed

+98
-5
lines changed

1 file changed

+98
-5
lines changed

README.md

Lines changed: 98 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,25 @@ The application allows users to read blog posts, login or signup to like a post,
44

55
While the code may not be perfect and may still contain bugs, the goal is to provide a practical, hands-on experience in building a real-world application. Your feedback and contributions are always welcome.
66

7+
8+
# Table of Contents
9+
1. [Demo](#demo)
10+
2. [Features](#features)
11+
3. [Tech Stack Versions](#tech-stack-versions)
12+
4. [YouTube Series](#youtube-series)
13+
5. [File Tree](#file-tree)
14+
6. [Configuration](#configuration)
15+
7. [Getting Started](#getting-started)
16+
8. [Build and Deployment](#build-and-deployment)
17+
9. [Who i am?](#who-i-am)
18+
10. [License](#license)
19+
11. [Contact](#contact)
20+
21+
22+
## 🎥 Demo
23+
[![PostShare](https://github.com/56duong/angular-springboot-blog-webapp/assets/77065902/58714ef0-01c8-441e-be85-5da51b469809)](https://youtu.be/FJDRKFNwubs?t=80&si=t7TiaLit9I77-UMY)
24+
25+
726
## 🌟 Features
827

928
- **User Authentication**: Secure authentication using JWT tokens for user login and signup.
@@ -38,7 +57,81 @@ Please note that the versions listed below are the ones used during the developm
3857
- **Electron**: 30.0.2
3958

4059
- **Capacitor**: 6.0.0
41-
60+
61+
62+
## 🎥 YouTube Series
63+
64+
This project is part of my [YouTube series](https://www.youtube.com/playlist?list=PLvEvS4scurJxs8_LILX2YxjV1pViXiv76), where I document the development process and share insights on building real-world applications. You can follow along with the series to view more about the application's architecture, implementation details, and best practices.
65+
66+
67+
## 📁 File Tree
68+
<pre>
69+
PostShare
70+
├───backend
71+
│ ├───src
72+
│ │ └───main
73+
│ │ ├───java
74+
│ │ │ └───org
75+
│ │ │ └───duong
76+
│ │ │ └───backend
77+
│ │ │ ├───config
78+
│ │ │ ├───controller
79+
│ │ │ ├───dto
80+
│ │ │ ├───enums
81+
│ │ │ ├───exception
82+
│ │ │ ├───filter
83+
│ │ │ ├───model
84+
│ │ │ ├───repository
85+
│ │ │ └───service
86+
│ │ └───resources
87+
│ │ ├───static
88+
│ │ └───templates
89+
│ │ └───application.properties
90+
│ └───target
91+
│ ├───backend-0.0.1-SNAPSHOT.jar
92+
│ ├───...
93+
├───frontend
94+
│ ├───android
95+
│ │ ├───app
96+
│ │ ├───release
97+
│ │ │ ├───app-release.apk
98+
│ │ │ ├───...
99+
│ │ └───...
100+
│ ├───dist
101+
│ │ └───frontend
102+
│ ├───PostShare-win32-x64
103+
│ │ ├───PostShare.exe
104+
│ │ └───...
105+
│ └───src
106+
│ ├───app
107+
│ │ ├───core
108+
│ │ │ ├───config
109+
│ │ │ ├───guard
110+
│ │ │ ├───interceptor
111+
│ │ │ ├───interface
112+
│ │ │ ├───pipe
113+
│ │ │ └───service
114+
│ │ ├───shared
115+
│ │ │ └───component
116+
│ │ │ ├───like-button
117+
│ │ │ ├───login
118+
│ │ │ ├───not-found
119+
│ │ │ ├───post
120+
│ │ │ ├───post-details
121+
│ │ │ └───signup
122+
│ │ ├───staff
123+
│ │ │ └───component
124+
│ │ │ ├───feed
125+
│ │ │ └───user-management
126+
│ │ └───user
127+
│ │ └───component
128+
│ │ └───feed
129+
│ └───assets
130+
├───installer
131+
│ ├───postshare-1.0.2.exe
132+
│ └───scripts.iss
133+
└───tsv
134+
</pre>
42135

43136
## ⚙️ Configuration
44137

@@ -116,7 +209,7 @@ These instructions will get you a copy of the project up and running on your loc
116209
117210
## 🔧 Build and Deployment
118211
119-
**1. Deploy MySQL Database to Azure**: Watch my [video]() for setup.
212+
**1. Deploy MySQL Database to Azure**: Watch my [video](https://youtu.be/kc0h2kc8uHQ?si=CldxUY_opymEkcg9) for setup.
120213
121214
**2. Angular Build and Copy Files to `resources/static`**:
122215
@@ -131,7 +224,7 @@ These instructions will get you a copy of the project up and running on your loc
131224
docker push your-dockerhub-username/your-image-name
132225
```
133226
134-
**4. Deploy Container to Azure**: Watch my [video]() for setup.
227+
**4. Deploy Container to Azure**: Watch my [video](https://youtu.be/Ivh9LUXARDc?si=g2Dv2Md8o8EIreRC) for setup.
135228
136229
**5. Mobile App Export**: Use Capacitor to prepare your app for mobile app.
137230
@@ -198,11 +291,11 @@ A young developer, who dedicated to developing usable apps, not just 'homework a
198291
I delight in sharing my knowledge and experiences, hoping to inspire others to embark on their own journey in application development. Also, I have a fondness for sour soup :bowl_with_spoon:.
199292
200293
201-
## License
294+
## :balance_scale: License
202295
203296
This project is licensed under the MIT License - see the [LICENSE](https://github.com/56duong/angular-springboot-blog-webapp/blob/master/LICENSE) file for details.
204297
205298
206-
## Contact
299+
## :incoming_envelope: Contact
207300
208301
If you want to contact me you can reach me at <56duong@gmail.com>. If you'd like to contribute, please fork the repository and use a pull request for changes.

0 commit comments

Comments
 (0)