Skip to content

Commit 8d4aa25

Browse files
Update README.md
1 parent 1c6d2d5 commit 8d4aa25

File tree

2 files changed

+7
-3
lines changed

2 files changed

+7
-3
lines changed

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,7 @@ A generic Express.js back-end service designed to support multiple front-end app
44

55
> Finding a hosting service with a free tier for dynamic deployment is difficult, so I combined the backend of multiple apps in this project to deploy and run it in production for free.
66
7-
## Disclaimer
8-
9-
I built this project to showcase what I am learning in web development, and I do not plan to keep maintaining it; therefore, _I added a reset feature to periodically delete any non-admin data_.
7+
![Data model diagram](./prisma/prisma-uml_c.png)
108

119
## Apps Consumes This Service
1210

@@ -18,6 +16,7 @@ I built this project to showcase what I am learning in web development, and I do
1816

1917
## Features
2018

19+
- **Bidirectional Communication**: Socket.IO server is used to support sending notifications from some of the endpoints.
2120
- **User Management:** Full CRUD operations for users, including sign-up, sign-in, and a special guest sign-in route.
2221
- **Authentication & Authorization:** Secure, JWT-based authentication using Passport.js, with support for partitioned cookies. It includes role-based access control, restricting certain actions to admins or resource owners.
2322
- **Blog Engine:** Complete CRUD functionality for posts, comments, and votes. Posts can be classified using a flexible tagging system.
@@ -39,6 +38,7 @@ I built this project to showcase what I am learning in web development, and I do
3938

4039
- [Node.js](https://nodejs.org/) / [Express 5](https://expressjs.com/)
4140
- [TypeScript](https://www.typescriptlang.org/)
41+
- [Socket.IO](https://socket.io/)
4242
- [Zod](https://zod.dev) for validation
4343
- [Winston](https://github.com/winstonjs/winston) for logging
4444
- [Multer](https://github.com/expressjs/multer) for file uploads
@@ -153,3 +153,7 @@ Every _push_ or _pull request (PR)_ on main branch, the app will be deployed to
153153
```
154154

155155
- A validation error response body will have the form of _[ZodError.issues](https://zod.dev/?id=error-handling)._
156+
157+
## Disclaimer
158+
159+
I built this project to showcase what I am learning in web development, and I do not plan to keep maintaining it; therefore, _I added a reset feature to periodically delete any non-admin data_.

prisma/prisma-uml_c.png

238 KB
Loading

0 commit comments

Comments
 (0)