diff --git a/staff/marti-herms/project/doc/README.md b/staff/marti-herms/project/doc/README.md index e69de29bb..79ba1279c 100644 --- a/staff/marti-herms/project/doc/README.md +++ b/staff/marti-herms/project/doc/README.md @@ -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) \ No newline at end of file diff --git a/staff/marti-herms/project/doc/images/preview.webp b/staff/marti-herms/project/doc/images/preview.webp new file mode 100644 index 000000000..a7dcfdb98 Binary files /dev/null and b/staff/marti-herms/project/doc/images/preview.webp differ