Skip to content
This repository was archived by the owner on Apr 21, 2023. It is now read-only.

Commit 90341bd

Browse files
Documents added in Docs Folder (#8)
* Mock UI Design Images * Added UI Design.md File * Added UI Design.md File * Added UI Design.md File * Project Archtecture, Functions, High Level DB, Readme files added * Readme updated * performed desired changes for the Documents in docs folder * performed desired changes for the Documents in docs folder
1 parent 08e0cee commit 90341bd

17 files changed

+95
-0
lines changed

docs/HighLevelDB.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# HIgh Level Data Base Schema
2+
3+
**Description:** The follwoing describes the structure of our database used for the project.
4+
5+
## Structure:
6+
![Structure](./assets/Structure.jpeg)
7+
8+

docs/Project_Architecture.md

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Project Architecture:
2+
3+
**Description:** The project architecture is as follows
4+
5+
## Technical Stack:
6+
![Technical Stack](./assets/TechnicalStack.png)
7+
8+
9+
**Description:**
10+
* **Frontend:** We have used React Native and JavaScript for the UI.
11+
* **API SErver:** We have used Flask as the API server.
12+
* **Backend:** We have used MySQL as our Database server as this is more relavent to our data structure.
13+
14+
## Architecture of the Project:
15+
![Architecture](./assets/Architecture.png)
16+
17+
18+
**Description:** The project Architecture is as above.
19+
20+
## Functions Used:
21+
![Functinons](./assets/Functions.png)
22+
23+
24+
**Dsscription:** The functions used in our Project.
25+
26+
## Use Case Diagram:
27+
![Usecase](./assets/UsecaseDiagram.png)
28+
29+
30+
**Description:** The in-app workflow will be as above.

docs/README.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# PASP Documentation
2+
3+
**To understand the following components of the project kindly refer to the following links**
4+
5+
* [UI Design](./UIdesigns.md)
6+
7+
* [Project Architecture](./Project_Architecture.md)
8+
9+
* [API Server Endpoints](./APIdesign.md)
10+
11+
* [High Level Database Schema](./HighLevelDB.md)

docs/UIdesigns.md

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# UI Design:
2+
3+
**Description:** This is a mockup design for our app.
4+
Our developers will be replicating the above design in this project.
5+
6+
## Sign In Page:
7+
![SignIn](./assets/SignIn.png)
8+
9+
10+
**Description:** A beautiful Sign In page for the users you have accounts
11+
12+
## Register Page:
13+
![Register](./assets/Register.png)
14+
15+
16+
**Description:** And for the new users to register
17+
18+
## Chat:
19+
![Chat](./assets/Chat.png)
20+
21+
22+
**Description:** Then the Chat Room, this is a communication platform where the users can interact with the available stewards to have a discussion on antibiotic usage and can also have exposure to antibiotics.
23+
24+
## Input System:
25+
![Input System](./assets/InputSystem.png)
26+
27+
28+
**Description:** This is a user intake system can be used to collect the data from the users on their antibiotic usage and help them to keep track of antibiotic consumption and also notify them incase of any danger or prone to some antimicrobial infection
29+
30+
## Dashboard:
31+
![Our Dynamic Dashboard](./assets/Dashboard.png)
32+
33+
34+
**Description:** A dynamic dashboard contains the national and individual user stats based on the antibiotic usage
35+
36+
## News:
37+
![The News](./assets/News.png)
38+
39+
40+
**Description:** A dynamic section help the users to educate themselves with the latest news and facts on antibiotics and thier usage
41+
42+
## Settings:
43+
![Settings](./assets/Settings.png)
44+
45+
46+
**Description:** The General App functions page

docs/assets/Architecture.png

102 KB
Loading

docs/assets/Chat.png

18.5 KB
Loading

docs/assets/Dashboard.png

18.3 KB
Loading

docs/assets/DatabaseSchema.jpeg

20.2 KB
Loading

docs/assets/Functions.png

71.1 KB
Loading

docs/assets/InputSystem.png

26.5 KB
Loading

docs/assets/News.png

14.6 KB
Loading

docs/assets/Register.png

52 KB
Loading

docs/assets/Settings.png

14.4 KB
Loading

docs/assets/SignIn.png

71.8 KB
Loading

docs/assets/Structure.jpeg

20.2 KB
Loading

docs/assets/TechnicalStack.png

43.8 KB
Loading

docs/assets/UsecaseDiagram.png

195 KB
Loading

0 commit comments

Comments
 (0)