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.
add project doc structure b00tc4mp#230
- Loading branch information
Showing
5 changed files
with
89 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,89 @@ | ||
| # [iMoveMe / yoMeMuevo] | ||
|
|
||
| ## Intro | ||
|
|
||
| [...] | ||
|
|
||
| #### image goes here | ||
|
|
||
|
|
||
| ## Functional | ||
|
|
||
|
|
||
| ### Use Cases | ||
|
|
||
| User (for example) | ||
| - create posts | ||
| - view posts | ||
| - toggole like posts | ||
| - add commment | ||
| - view comments | ||
| - remove comments | ||
| - add review | ||
| - edit review | ||
| - remove review | ||
| - report/flag content | ||
| - add wiki | ||
|
|
||
| Admin | ||
| - view reports | ||
| - delete user | ||
| - delete post | ||
| - remove comment | ||
| - [...] | ||
|
|
||
| ### UXUI Design | ||
|
|
||
| [Figma] (figma URL) | ||
|
|
||
| ## Techinal Aspects | ||
|
|
||
| ### Blocks | ||
|
|
||
| - App (client-side application) | ||
| - API (server-side application) | ||
| - DB (the database) | ||
|
|
||
| ### Packages | ||
|
|
||
| - doc ( documentation) | ||
| - app (client-side application) | ||
| - api (server-side API) | ||
| - dat (data model and driver) | ||
| - com (common validation, 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 (...) | ||
| - Mocha & Chai (...) | ||
| - [...] | ||
|
|
||
| ### Test Coverage | ||
|
|
||
| - Mocha & Chai |