Design Puya mini program

django angular deploy mimi_program

PRD

1. Record the books we bought;
2. Employee can 'wish' the book which they want to buy;
3. Employee can 'borrow' the book we bought
4. Library administrator can buy the book is wished by employee
5. Library administrator can recruit and kick out people
6. Statistics employee redading status

SRS

Structure

DB schema

1. PyUser

2. Book

API spec

1. login

   # login from backend ui
   URL: /api/v1/ologin/ 
   method: POST
   Data: 
       {
           'username': 'name',
           'password': 'password'
       }
   ret:
       {
           access_token: "Ro6yB0jLu7xubC6zTbAox4cEb9eXgy"
           expires_in: 36000
           refresh_token: "7O7jpcl0HgC8quMD8WbfwdPm7DO3Qd"
           scope: "read write"
           token_type: "Bearer"
       }
   # login from mini program
   URL: /api/v1/wxlogin/ 
   method: POST
   Data: 
       {
           'code': 'xxxxxxx',
           'userinfo': {
                   {
                       "nickName": "NICKNAME",
                       "gender": GENDER,
                       "city": "CITY",
                       "province": "PROVINCE",
                       "country": "COUNTRY",
                       "avatarUrl": "AVATARURL",
               }
       }
   ret:
       {
           "token": token.token,
           "token_type": "Bearer",
           "user_type": pu.type,
           "user_id": u.id
       }

2. user operation

   # operation on a user
   URL: /api/v1/pyuser/ 
   method: POST
   Data: 
       {
           'uid': 'user id',
           'operation': 'join, leave'
       }
   ret:
       {
           'id': u.id,
           'nickname': u.pyuser.nickname,
           'avatarUrl': u.pyuser.avatarUrl,
           'type': u.pyuser.type,
           'date_joined': u.date_joined,
           'borrowed_num': Book.objects.filter(owner=u, status=BOOK_STATUS_BORROWED).count()
       }
   # get pyuser list info
   URL: /api/v1/pyusers/ 
   method: GET
   Data: 
       {}
   ret:
       {
           data: [
                   {
                       'id': py_user.user.id,
                       'nickname': py_user.nickname,
                       'avatarUrl': py_user.avatarUrl,
                       'type': py_user.type,
                       'date_joined': py_user.user.date_joined,
                       'borrowed_num': Book.objects.filter(owner=py_user.user, status=BOOK_STATUS_BORROWED).count()
                   },
               ]
       }

3. book operation

   # operation on a book
   URL: /api/v1/book/ 
   method: POST
   Data: 
       {
           'operation': 'wish, buy, borrow, return',
           'book_id': '123'
       }
   ret:
       {
           'book_info': book_info,
           'status': book.status,
           'owner': book_owner,
           'wishers': book.wishers.all().values(
               'id', 'pyuser__nickname', 'pyuser__avatarUrl'
           )
       }
   # get book list info
   URL: /api/v1/books/ 
   method: GET
   Data: 
       {
           'type': 'wish, all',
       }
   ret:
       {
           data: [
                   {
                       'book_info': str_book_info,
                       'status': book.status,
                       'owner': {
                           'id': book.owner.id,
                           'nickname': book.owner.pyuser.nickname,
                           'avatarUrl': book.owner.pyuser.avatarUrl
                       },
                       'wishers': book.wishers.all().values(
                           'id', 'pyuser__nickname', 'pyuser__avatarUrl'
                       )
                   },
               ]
       }

User types

1. Visitor
   
   • browse all the books in the market and library
   • Can not do action on the book, for example: wish, borrow, return
2. Employee
   
   • browse all the books in the market and library
   • Do action on the book, for example: wish, borrow, return
3. Admin
   
   • recruit and kick out employee (user type from visitor to employee; from employee to visitor)
   • buy the book wished by employee

User management

1. User register
   
   • library admin is created by default
   • every people register from mini program
2. User login
   
   • library admin can only login from admin UI
   • other user login from mini program
3. Recruit and kick out people
   
   • library admin login backend, can transfer the user type from visitor to employee and reverse this operation

Book management

1. Book status

   • in the market
   • in the library
   • borrowed

2. Book operation

   1. get the book list from douban
      
      • user login from mini program, the mini program get the book list from douban directly
   2. wish the book
      
      • employee login from mini program
      • mini program get the book info from backend (need the check the book status)
      • add this book info in db:
        
        • the book status is "in the market",
        • add this user in wisher filed of book item
   3. buy the book
      
      • admin login backend ui
      • list the books in the backend
      • transfer book status from "in the market" to "in the library", and the owner is admin, clear up wihser field

   4. borrow the book

      • employee login from mini program
      • mini program get the book info from backend
      • transfer the books status from "in the library" to borrowed and the owner is the employee if the book status is "in the library"

   5. return the book

      • employee login from mini program
      • mini program get the book info from backend
      • transfer the books status from borrowed to "in the library" and the owner is admin if the book status is "borrowed" and owner is himeself