Skip to content

Commit

Permalink
create doc README.md b00tc4mp#84
Browse files Browse the repository at this point in the history
  • Loading branch information
Eden23 committed Jul 30, 2024
1 parent 70a672a commit ed305e1
Show file tree
Hide file tree
Showing 2 changed files with 59 additions and 0 deletions.
59 changes: 59 additions & 0 deletions staff/marti-herms/project/doc/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
# The V-HUB

A hub for gamers and developers to play or upload videogames

![V-Hub image](./images/preview.webp)

## Functional

### Use Cases

[?]

### UIUX Design

[Figma](https://www.figma.com/files/team/1381930055088856376/project/256028731/Project?fuid=1381930053009727034)

## 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)
- role (string)
- library ([Game.id])

Game
- id (string)
- name (string)
- image (string)
- link (string)
- downloads (number)
Binary file not shown.

0 comments on commit ed305e1

Please sign in to comment.