search

BauPhi / bauphi-backend

BauPhi Rest API, written using Node.js.
MIT License
0 stars 0 forks source link

[Planning] As developers, we would like to define an architecture diagram and common data model. #1

Closed tunahanertekin closed 3 years ago

tunahanertekin commented 3 years ago

Project Architecture

BauPhi Architectural Diagram

tunahanertekin commented 3 years ago

Software Components & Common Data Model

Software Components

Here are the software components defined for BauPhi.

  1. As a developer, I would like to create a documentation for the backend service that includes planning request-response formats.
  2. As a developer, I would like to create endpoints which include JSON responses.
  3. As a developer, I require a framework for SQL handling.
  4. As a developer, I would like to handle the relationship between database and application layer in controller classes.
  5. As a developer, I need a framework to handle login attemps from Facebook/Google accounts.
  6. As a developer, I require better security for the data
  7. As a developer, I would like to handle sign in and sign up process. (Included Google/Facebook) (for iOS)
  8. As a developer, I would like to create different usage modes (e.g. anonymous login or incognito mode) (for iOS)
  9. As a developer, I would like to enable users to add homes / announcement / events to the system. (for iOS)
  10. As a developer, I would like to users be able to list homes / announcements / events close to their area. (for iOS)
  11. As a developer, I would like to users be able to define addresses with location information. (for iOS)
  12. As a developer, I would like to design web-client interface to be user-friendly and responsive. (for iOS)
  13. As a developer, I would like to design a push notification schema and send notification to user when needed.

Common Data Model

Common Data Model defines the relationship and data flow between components. Every component has been assigned to one team member.

Common Data Model Image