Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Created markdown file for technical specification of native and flutter android #63

Merged
merged 6 commits into from
Nov 1, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions blog/2019-05-29-long-blog-post.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
slug: long-blog-post
title: Long Blog Post
authors: endi
tags: [hello, docusaurus]
title: Zuri Token
authors: dav
tags: [hello, Zuri]
---

This will be used for workflow documentation
## Zuri Token Introduction

2 changes: 1 addition & 1 deletion blog/authors.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
endi:
dav:
name: Endilie Yacop Sucipto
title: Maintainer of Docusaurus
url: https://github.com/endiliey
Expand Down
20 changes: 20 additions & 0 deletions docs/Plugins/CreateAccount.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# How To Create an Account on the Zurichat App

To use the zurichat mobile app you need to create an account, this can be done by downloading the App from PlayStore or App Store, then follow the listed steps

1. Click on 'Sign Up' on launch of the app
2. Enter your First Name, Last Name, Email Address, Password, Confirm your password by putting in the password again
3. Check the box to agree to the terms and conditions
4. Click on Create Account
5. An OTP (One-Time-Password) will be sent to your email
6. Input the OTP on the password page
7. Account is created successfully
8. Enter in your email address and password to "Sign In" to the app.

```
OR
```
1. Click on "Sign Up with Google"
2. Enter your Google Email Address
3. Enter your password.

31 changes: 31 additions & 0 deletions docs/Plugins/flutterandroid.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
slug: /Flutter-Android
sidebar_position: 1
title: Flutter-Android App
---


# Technical Specifications for Zurichat Android Flutter App

This contains the technical specifications for zuri android native app
### Platform
The ZuriChat Mobile app was built with Flutter, a trending technology owned by Google. Flutter is a powerful UI toolkit powered by Dart for building beautiful, natively compiled applications for mobile, web, desktop, and embedded devices from a single codebase. Codebase architecture and state management is Stacked (with MVVM)

### Supporting Versions of the OS
- Android versions 4.4 Kitkat through 12
- IOS *(not tested yet)


### Information on the Servers
- Server and Online DB: Auth: Zuri Core, DMs and Channels: Zuri Main
- In-app Services: taken care by the - architecture and state management tool.
- Local Database: SharedPreferences and Hive* or SQflite*

### API/Services Doc
- Zuri core: https://docs.zuri.chat/
- DMs: https://docs.zuri.chat/dm_chat
- Channels: https://docs.zuri.chat/channels

### Credentials/Developers Accounts for Google Playstore
- Playstore Account Link: https://play.google.com/store/apps/developer?id=The+Zuri+Team
- Apple Store Account Link: None Yet
26 changes: 26 additions & 0 deletions docs/Plugins/nativeandroid.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
slug: /Native-Android
sidebar_position: 1
title: Native-Android App
---


# Technical Specifications for Zurichat Android Native App

This contain the technical specifications for zuri android native app
### Platform
Android Operating System

### Supporting Versions of the OS
minSDK - API level 21 (lollipop)(>API21)

### Information on the Servers
Zuri core4 Backend
minSDK - API level 21 (lollipop)(>API21)
### API/Services Doc
- Zuri core: https://docs.zuri.chat/
- DMs: https://docs.zuri.chat/dm_chat
- Channels: https://docs.zuri.chat/channels

### Credentials/Developers Accounts for Google Playstore
https://play.google.com/store/apps/developer?id=The+Zuri+team
Empty file added docs/eunice.md
Empty file.
24 changes: 12 additions & 12 deletions docs/sidebar.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
#Sidebar Documentation
Documentation of the protocols for sidebar
# Documentation of the protocols for sidebar

#### Adding plugin to the Sidebar
### Adding plugin to the Sidebar
Example url:
> https://example.zuri.chat/sidebar
###### Sample Response
Expand All @@ -19,7 +18,7 @@ Example url:
```


##### Plugin categories
#### Plugin categories
```
"games"
"utility"
Expand All @@ -28,13 +27,14 @@ Example url:
"sales"
"productivity"
```
#####Rules for grouping plugins
#### Rules for grouping plugins
1. If your plugin is a single room that should show up on the top level, don't include the `category` key in your data.
2. If your plugin is a single room that should show up under a `category`, set the `category` to any of the category options above, then set `show_group` to `false`.
If your plugin need it's own group, set the `category` to any the category options above, then set `show_group` to `true` , then make sure you set a `group_name`

> NB: If plugin is a single room don't add `category` to sidebar payload
######Sample Response
>
#### Sample Response
```json
{
"name": "Plugin",
Expand All @@ -48,7 +48,7 @@ If your plugin need it's own group, set the `category` to any the category optio
}
```

#### Update Sidebar Realtime
### Update Sidebar Realtime

`Subscribe to channel for sidebar update`
> currentworkspace_memberid_sidebar
Expand All @@ -73,7 +73,7 @@ Payload:
}
```

####Send Notification
### Send Notification
Payload:
```json
{
Expand All @@ -89,10 +89,10 @@ Payload:
"public_rooms": [],
"joined_rooms": [
{
room_name: "Room name",
room_url: "/room-url"
room_image: "https://image.com"
unread: 10
"room_name": "Room name",
"room_url": "/room-url"
"room_image": "https://image.com"
"unread": 10
}
]
}
Expand Down