Skip to content

Commit

Permalink
add README b00tc4mp#233
Browse files Browse the repository at this point in the history
  • Loading branch information
Jonasveronn committed Nov 16, 2024
1 parent eedc206 commit d2c6f52
Show file tree
Hide file tree
Showing 5 changed files with 79 additions and 0 deletions.
Empty file.
Empty file.
Empty file.
Empty file.
79 changes: 79 additions & 0 deletions staff/jonas-veron/project/doc/README.md
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

0 comments on commit d2c6f52

Please sign in to comment.