Project Architecture

[BalazsSipos]

Plan the list of building blocks both on frontend and backend.

[BalazsSipos]

Architecture:

Frontend:

• React js with Typescript
• Test framework: React testing library or Jest -> 1. snapshot test, 2. unit test
• Deployed by Vercel
• CICD: GitHub Actions
• Design: Material UI
• State Management: React Query
• Data Validation:
• vo vs model mapper:

Backend:

• Express js with Typescript
• Test framework: React testing library or Jest -> 1. snapshot test, 2. unit test
• CICD: GitHub Actions (Deploy to Google Cloud Run by GitHub Actions)
• Infra?: Terraform or Pulumi (Farkas Gábor)
• Database: Google Cloud Firestore
• REST API
• Authentication: Firebase Auth
• Data Validation:
• vo vs model mapper:

General:

• All deploy should be automatic, when GitHub is updated
• One repo for everything
• Server Side Rendering is out of scope
• End to end testing is out of scope
• Dependency Injection is out of scope
• Internationalization:

Models:

User:

• uid
• name
• email
• image

Todo:

• tid
• title
• description
• location
• starting date
• isdone
• progress
• created at
• created by
• performed by

API endpoints:

/api/users/...

• GET .../ - retrieve all users
• POST .../signup - create new user + log user in
• POST .../login - log user in

/api/todos/...

• GET .../user/:uid - retrieve all todos created by or performed by the user
• GET .../:tid - get a specific todo by todoid
• POST .../ - create a new todo
• PATCH .../:tid - update a todo by todoid
• DELETE .../:tid - delete a todo by todoid

SPA pages:

• / - list of users - always reachable
• /:uid/todos - list of todos of selected user - only authenticated
• /auth - signup or login form - only un-authenticated
• /todos/new - new todo form - only authenticated
• /todos/:tid - update todo form - only authenticated