forked from b00tc4mp/isdi-bootcamp-202405
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
create README document in ponies b00tc4mp#68
- Loading branch information
1 parent
cd273f0
commit d5a4dec
Showing
1 changed file
with
69 additions
and
0 deletions.
There are no files selected for viewing
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,69 @@ | ||
# Ponies | ||
|
||
lorem ipsum ... | ||
|
||
![Pony Image](https://media.giphy.com/media/8gagdpcAhA8AuVerUn/giphy.gif?cid=790b7611jc6mx4hntg3ddlkj4jcm5l4t0ul8stuw2mygm2ji&ep=v1_gifs_search&rid=giphy.gif&ct=g) | ||
|
||
## Functional | ||
|
||
### Use Cases | ||
|
||
User | ||
- create post | ||
- list posts | ||
- list ponies posts | ||
- list saved posts | ||
- toggle like post | ||
- toggle fav post | ||
- toggle follow user | ||
- update post | ||
- delete post | ||
|
||
### UIUX Design | ||
|
||
[Figma](https://www.figma.com/design/7ohsVM69EEKTn7TiG5yWTb/ponies?node-id=0-1&t=U6MSAuJNfld3IeuT-0) | ||
|
||
## Tecnical | ||
|
||
### Blocks | ||
|
||
- App (user interface) | ||
- API (core logic) | ||
- DB (data storage) | ||
|
||
### Packages | ||
|
||
- api (server) | ||
- cor (core logic dependency to api) | ||
- com (common dependencies to api and app) | ||
- app (client) | ||
- doc (project documentation) | ||
|
||
### Technologies | ||
|
||
- HTML / CSS / JS | ||
- Node | ||
- Express | ||
- React | ||
- Mongo | ||
|
||
### Data Model | ||
|
||
User | ||
- id (string) | ||
- name (string) | ||
- surname (string) | ||
- email (string) | ||
- username (string) | ||
- password (string) | ||
- avatar (string) | ||
- favs ([Post.id]) | ||
- following ([User.username]) | ||
|
||
Post | ||
- id (string) | ||
- author (User.username) | ||
- image (string) | ||
- caption (string) | ||
- date (Date) | ||
- likes ([User.username]) |