forked from b00tc4mp/isdi-bootcamp-202409
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
eedc206
commit d2c6f52
Showing
5 changed files
with
79 additions
and
0 deletions.
There are no files selected for viewing
Empty file.
Empty file.
Empty file.
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,79 @@ | ||
# [DanceApp!] | ||
|
||
## Intro | ||
|
||
## Functional | ||
|
||
### Use Cases | ||
|
||
User | ||
|
||
-view post | ||
-toggle like post | ||
-delete post | ||
-add comment | ||
-view comments | ||
-remove comment | ||
-report user | ||
-report post | ||
-report comment | ||
|
||
Admin | ||
-create post | ||
-delete user | ||
-delete post | ||
-remove comment | ||
|
||
### UXUI Design | ||
|
||
[Figma](https://figma.com) | ||
|
||
## Technical | ||
|
||
### Blocks | ||
|
||
- App (the client-side application) | ||
- API (the server-side API) | ||
- DB (the database) | ||
|
||
### Packages | ||
|
||
- doc (the documentation) | ||
- app (the client-side application) | ||
- api (the server-side API) | ||
- dat (the data model and driver) | ||
- com (the common validations, utils, ...) | ||
|
||
### Data Model | ||
|
||
User | ||
|
||
- id (UUID) | ||
- name (string) | ||
- email (string) | ||
- username (string) | ||
- password (string) | ||
|
||
Post | ||
|
||
- id (UUID) | ||
- author (User.id) | ||
- image (string) | ||
- text (string) | ||
- date (Date) | ||
- likes ([User.id]) | ||
- comments ([{ | ||
- id (UUID) | ||
- author (User.id) | ||
- text (string) | ||
- date (Date)}]) | ||
|
||
### Techs | ||
|
||
- HTML/CSS/JS | ||
- React | ||
- Node | ||
- Express | ||
- Mongo | ||
|
||
### Test Coverage |