• year field from some table are text and some are integer
• update and adjust with integer
• add user table column active
• add updated migrate file

change, address, attendance, school, transfer, user get by id query result to singular form .
If the designated format already singular, neglect it.

• https://github.com/thingaha/thingaha-web/blob/master/backend/docs/address.md#get-address-by-id
• https://github.com/thingaha/thingaha-web/blob/master/backend/docs/attendance.md#get-attendance-by-id
• https://github.com/thingaha/thingaha-web/blob/master/backend/docs/schools.md#get-school-by-id
• https://github.com/thingaha/thingaha-web/blob/master/backend/docs/transfer.md#get-transfer-by-id
• https://github.com/thingaha/thingaha-web/blob/master/backend/docs/users.md#get-user-by-id

We need to do a few small improvements to User List page and User Form.

• User list page currently do not show username in the cards. Please add username to the card.
• We need to add a password for user on creation. For now, we only want to add password field when creating user but not on edit because we plan to have a password update form feature for users separately.

User list page currently have functionality to add new user but editing a user is not implemented yet.

Also we would want to add a User detail page too so that we can link a user to its detail page from other pages.

Mockups

Edit Form

Please re-use New user form.

Detail page

Coming soon

Currently, whenever we refresh the page, we are redirected to login page even though we already logged in.
Please persist in the login state and support logout functionality.

• Search by student name
• Search by school name
• filter by grade, year
• filter by year

In address management page, we want to show which record a given address is belonged to. For example, if an address is a school address, we want to show a link to school.

So, we need that data in the API response. The expected format for each address is as follow:

     {
        "id": 1,
        "addressable": {
          "id": 1,
          "name": "Maung Maung",
          "type": "Student"
        },
        "division": "ayeyarwaddy",
        "district": "Maubin",
        "township": "Nyaungdon",
        "street_address": "RZarni Road"
      }

Transfer Management Page

• Transfer List Page
• Transfer Detail Page
• New Transfer Record Form
• Edit Transfer Record Form

Please refer to backend api docs here.

For draft server json, please refer here.

Mockups

Transfer List Page Desktop Mockup

Transfer List Page Mobile Mockup

Trasnfer Popup Form Mockup

Transfer Detail Page Desktop Mockup

Transfer Popup Form Desktop Mockup

Transfer Detail Page Mobile Mockup

To know who is current user, we need more information than just access token from login endpoint.

Please update login endpoint to return the following information:

{
   access_token: '...',
   user: {
      id: 1,
      email: '[email protected]',
       username: 'moemoe'
    }
}

Also, please update the error response format to this format:

{
  errors: [
    {
      error_code: "E0001",
      reason: "Validation Failed",
      description: "Invalid email or password."
    }
  ]
}

• Create an overall flowchart for Thingaha Donation Web page.
• Lists the functionality
• Draw a use case

Create login page for the app and implement storing JWT in local storage.

• only do password change action

• CRUD address
• join the result of user with addresses table
• instead of address_id show the address in results
• delete action
• update action
• read action modification (all, by id, by username)

current action in local server is created and read ->
http://localhost:5000/api/v1/user
POST body

{
    "name": "khinezar4", 
    "email": "[email protected]", 
    "password" : "123", 
    "role": "admin", 
    "country": "mm"
    "division": "ayeyarwady",
    "district": "maubin",
    "township": "nyaungdon",
    "street_address": "Rzarni Road"
}

desired format:
https://github.com/thingaha/thingaha-web/blob/master/draft_server/sample_data/users.json

Please referenc this for backend setup

adding API authentication for api call
use json web token (jwt)

Address Management Page

Address management page is to manage various types of addresses that we create through the app in one place. There are three types of records that will be associated with an address.

• Student
• Donator
• School

We will provide the associated record as addresseable in the Address record json. The example response format is added in the draft server here.

We will be supporting search but it is not necessary to implement search in this ticket. We're planning to have separate issues search in various pages later.

• Address List Page

UI Mockups

Address List View (Desktop version)

Address List View (Mobile version)

Frontend

Setup Create React App setup with basic packages

• add column in student table for student photo URL save
• integrate with S3
• save S3 URL in student table
• delete S3 URL
• edit URL

• Search by name and email
  api/v1/users/search?query=XXX
• Filtered by role
  api/v1/users?role=XXXX
• Filtered by country
  api/v1/users?country=XXXX

Desired Format
https://github.com/thingaha/thingaha-web/blob/master/draft_server/sample_data/attendances.json

Desired Format
https://github.com/thingaha/thingaha-web/blob/master/draft_server/sample_data/transfer.json

• Donation user list
• payment update list
• jp payment list
• mm payment list
• update payment status
• live update for payment action

• search name
• search by contact info
• search by address

https://github.com/thingaha/thingaha-web/blob/master/draft_server/sample_data/students.json

Backend Data Sample Format
https://github.com/thingaha/thingaha-web/blob/master/draft_server/sample_data/extrafunds.json

• Create UI design for Attendance Page

• The draft attendance data is here

After the project ENV setup function of db_migrate, db_seed, insert the record via API can't insert correctly.
For example,
User data seed is 1 row for Users table.
Then, User creates from API fails for the first request and throw an error.
db_seed.sh already insert id:1 for user. When creating the user via API, throw an error for ID:1
ERROR reason, Primary KEY ERROR

Since school api is ready now, we should implement actual backend api calls with School page while implementing pagination structure altogether.

• Attendance Page from sketch
• Attendance List Page
• Attendance Registration Page
• Attendance Edit Page
• Attendance Detail Page

Desired Format
https://github.com/thingaha/thingaha-web/blob/master/draft_server/sample_data/extrafunds.json

• Create Extra funds
• Delete Extra funds (by ID)
• EDIT Extra funds (by ID)
• READ Extra funds (All, ID)
• Write Doc for Extra funds
• Add test code for Extra funds API
• update postman json file
• add DB seed

Sample output for user get API

• CRUD address
• delete action
• update action
  current action in local server is created and read ->
  http://localhost:5000/api/v1/address

desired format:
https://github.com/thingaha/thingaha-web/blob/master/draft_server/sample_data/addresses.json

Background

We need a page to manage students.

Task

Implement student list page using student draft api. (https://github.com/thingaha/thingaha-web/blob/master/draft_server/sample_data/students.json)

• Use a table view similar to users page.
• Students with deactivated_at set need to be grayed out. (or use some other visual cue)
• address needs to be combined into a sentence

• use pytest
• currently we have only test_app.py
• test coverage for all functions

Currently, we don't have paginations and limits for APIs.
adding paginations and limit, default limit for all APIs

We need to be able to add new users and edit users.

The idea is to have an add user button above users table and when clicked, show a popup form with the following fields:

• username
• password
• password_confirmation
• email
• address
• role
• country

Potentially use material UI modal and forms. For now, just handle user creation with a dynamic in-memory array in reducer. We'll have a separate ticket for backend integration.

Consider using a form library for react. eg. https://formik.org/

• DB model setup in python app
• Create Database using python
• adding env-sql

Data Excel files
2020-2021 Data
https://docs.google.com/spreadsheets/d/1KV6HliHit2_u5L1kd2zVNSRc70mtsDMm5oIc02Cs2Y4/edit?usp=sharing

2019-2020 Data
https://docs.google.com/spreadsheets/d/1U4kvQ1KBSfY_aXU5QAqnjG5V6dhOWDkTKibXfM345MQ/edit?usp=sharing

2018-2019 Data
https://docs.google.com/spreadsheets/d/1Lavtz1pqH_rd3Fs6LSwfRPJ_qxfbXrOEHJYH2uv7dnQ/edit?usp=sharing

2017-2018 Data => need to change Unicode
https://docs.google.com/spreadsheets/d/1ESlGja8kIgyt-HcajSvV3BWF5CnhWNC1ir1ydZPNYL0/edit?usp=sharing

2016-2017 Data => need to change Unicode
https://docs.google.com/spreadsheets/d/1SUPxTxuRBqzzm1OGsDAvDLPs9tpr_yvtP3vtQmOnVeg/edit?usp=sharing

• Write a data seed file based on real data for DB initial data

please reference
https://github.com/thingaha/thingaha-web/blob/master/backend/src/db_seed.py

We have three user types in User role.

• admin

• sub-admin

• donator

• Define APIs for only admin can do

• Define APIs for only sub-admin can do

• Define APIs for only donator can do

• Define admin Functions

• Define sub-admin functions

• Define donator admins

• Create Entity Chart for User Role management

School Management page

Background

Admin needs to manage schools so that we can map which student attends which school.

Task

We just need a normal CRUD page for schools.

School record will have:

• id (integer, primary)
• name (string)
• contact_info (string)
• address (string)

For UI mockup, we're thinking of a simple card style list view just like in users page.

For new school and edit school form, we prefer popup form if possible.

Mockups

List view

Added pagination for future reference. It hasn't been implemented by backend yet. We can update it later.

Popup Form

This form layout should be shared between new record form and edit record form.

We're going to store separate parts for address. For now, we can just embed address fields as part of school form component. But we would like to extract one single address fields component in the future because we have a couple place to share address form.

• filtered by type
• filtered by district, division
• full text search by township
• full text search by street address

Desired Format
https://github.com/thingaha/thingaha-web/blob/master/draft_server/sample_data/donations.json

• Extra Fund page from sketch
• Extra Fund registration page
• Extra Fund Edit page
• Extra Fund List Page

Draw Database Relationship Diagram

• search by name
• search by father_name
• search by mother_name
• search by parents_occupation

Sidebar menu is currently not responsive.

Please convert it into drawer menu from Material UI.

Desired format
https://github.com/thingaha/thingaha-web/blob/master/draft_server/sample_data/schools.json