Skip to content
This repository has been archived by the owner on Oct 23, 2023. It is now read-only.

Commit

Permalink
chore: improve README.md and add model's images
Browse files Browse the repository at this point in the history
  • Loading branch information
AndreaBrighi committed Jul 24, 2023
1 parent beb0445 commit 618ed89
Show file tree
Hide file tree
Showing 10 changed files with 41 additions and 1 deletion.
22 changes: 21 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,24 @@
[![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=IntelligentBackpack_IntelligentBackpackApp&metric=ncloc)](https://sonarcloud.io/summary/new_code?id=IntelligentBackpack_IntelligentBackpackApp)
[![Technical Debt](https://sonarcloud.io/api/project_badges/measure?project=IntelligentBackpack_IntelligentBackpackApp&metric=sqale_index)](https://sonarcloud.io/summary/new_code?id=IntelligentBackpack_IntelligentBackpackApp)
[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=IntelligentBackpack_IntelligentBackpackApp&metric=reliability_rating)](https://sonarcloud.io/summary/new_code?id=IntelligentBackpack_IntelligentBackpackApp)
[![Duplicated Lines (%)](https://sonarcloud.io/api/project_badges/measure?project=IntelligentBackpack_IntelligentBackpackApp&metric=duplicated_lines_density)](https://sonarcloud.io/summary/new_code?id=IntelligentBackpack_IntelligentBackpackApp)
[![Duplicated Lines (%)](https://sonarcloud.io/api/project_badges/measure?project=IntelligentBackpack_IntelligentBackpackApp&metric=duplicated_lines_density)](https://sonarcloud.io/summary/new_code?id=IntelligentBackpack_IntelligentBackpackApp)

## Architecture

![Architecture](architecture.jpg)

## Description

The Intelligent Backpack is a project that aims to help user to organize their school life.
The mobile application is used to scan the QR code of the backpack and connect it to the user account.
Then the user can add school supplies to the account (books for now).
The teacher will be able to add a book to a lesson and the student will be able to see the books he needs for the next lesson of the day.
The student will also be notified when he has missed a school supply.

## Requisites

- Java 17
- Android Studio Giraffe | 2022
- Android SDK 29 (Android 10.0) or higher
- Android SDK Build-Tools 29.0.2 or higher
- Android Emulator or Android Device
5 changes: 5 additions & 0 deletions accessDomain/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Access Domain

## UML Diagram

![UML Diagram](model.jpg)
Binary file added accessDomain/model.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added architecture.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 5 additions & 0 deletions desktopDomain/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Desktop Domain

## UML Diagram

![UML Diagram](model.jpg)
Binary file added desktopDomain/model.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 5 additions & 0 deletions reminderDomain/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Reminder Domain

## UML Diagram

![UML Diagram](model.jpg)
Binary file added reminderDomain/model.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 5 additions & 0 deletions schoolDomain/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# School Domain

## UML Diagram

![UML Diagram](model.jpg)
Binary file added schoolDomain/model.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 618ed89

Please sign in to comment.