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

Documents added in Docs Folder #Documentations #8

Merged
merged 9 commits into from
Aug 1, 2020
8 changes: 8 additions & 0 deletions docs/HighLevelDB.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# HIgh Level Data Base Schema

**Description:** The follwoing describes the structure of our database used for the project.

## Structure:
![Structure](./assets/Structure.jpeg)


30 changes: 30 additions & 0 deletions docs/Project_Architecture.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Project Architecture:

**Description:** The project architecture is as follows

## Technical Stack:
![Technical Stack](./assets/TechnicalStack.png)


**Description:**
* **Frontend:** We have used React Native and JavaScript for the UI.
* **API SErver:** We have used Flask as the API server.
* **Backend:** We have used MySQL as our Database server as this is more relavent to our data structure.

## Architecture of the Project:
![Architecture](./assets/Architecture.png)


**Description:** The project Architecture is as above.

## Functions Used:
![Functinons](./assets/Functions.png)


**Dsscription:** The functions used in our Project.

## Use Case Diagram:
![Usecase](./assets/UsecaseDiagram.png)


**Description:** The in-app workflow will be as above.
11 changes: 11 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# PASP Documentation

**To understand the following components of the project kindly refer to the following links**

* [UI Design](./UIdesigns.md)

* [Project Architecture](./Project_Architecture.md)

* [API Server Endpoints](./APIdesign.md)

* [High Level Database Schema](./HighLevelDB.md)
46 changes: 46 additions & 0 deletions docs/UIdesigns.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# UI Design:

**Description:** This is a mockup design for our app.
Our developers will be replicating the above design in this project.

## Sign In Page:
![SignIn](./assets/SignIn.png)


**Description:** A beautiful Sign In page for the users you have accounts

## Register Page:
![Register](./assets/Register.png)


**Description:** And for the new users to register

## Chat:
![Chat](./assets/Chat.png)


**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.

## Input System:
![Input System](./assets/InputSystem.png)


**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

## Dashboard:
![Our Dynamic Dashboard](./assets/Dashboard.png)


**Description:** A dynamic dashboard contains the national and individual user stats based on the antibiotic usage

## News:
![The News](./assets/News.png)


**Description:** A dynamic section help the users to educate themselves with the latest news and facts on antibiotics and thier usage

## Settings:
![Settings](./assets/Settings.png)


**Description:** The General App functions page
Binary file added docs/assets/Architecture.png
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 docs/assets/Chat.png
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 docs/assets/Dashboard.png
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 docs/assets/DatabaseSchema.jpeg
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 docs/assets/Functions.png
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 docs/assets/InputSystem.png
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 docs/assets/News.png
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 docs/assets/Register.png
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 docs/assets/Settings.png
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 docs/assets/SignIn.png
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 docs/assets/Structure.jpeg
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 docs/assets/TechnicalStack.png
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 docs/assets/UsecaseDiagram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.