chomosuke / it-project-porkbellypro

Richard Li

Just a random dude who's into programming

Knows more stuff than I need

Languages

Library, Frameworks & Platforms

Contribution to Open Source

Visit my personal website to see more.

Pull Requests

awesome-neovim 13963

• Add chomosuke/typst-preview.nvim
• Add chomosuke/term-edit.nvim

neovide 11863

• Remember windows size via pixel
• Fixes window position not being remembered on multi-monitor
• Neovide crashes when both x & y blur are set to 0

nvim-tree.lua 6455

• feat: Indicate modified buffers
• Improve git icons on directories
• feat(diagnostics): only show diagnostic and git icon on closed folder
• fixed: git rename not showing up for the renamed file
• 1786 git next prev land on dirs
• 1836 view debounce delay
• fix diagnostics showing up on file/dir with same prefix
• Fixed highlight-opened-files doesn't automatically refresh
• Fix nvim tree frozen with no name buffer

logiops 3069

• Prevent false positive in secondary axis for gestures

onedark.nvim 1383

• Adding semantic token support
• changed rainbowcol1 to lightgrey

neoscroll.nvim 1256

• Fixed zz doesn't center the due to wrapped line

styled_widget 1210

• added limitedBox extension
• Add Material & MouseRegion extention

eslint-config-airbnb-typescript 1019

• chore: bumped peerDependencies to reflect the use of space-before-blocks

ocaml-cohttp 683

• Cookies: case-insensitive check of set-cookies

ts-auto-guard 475

• Check if object is a function if the type idicates so

syntax-tree-surfer 455

• Update README 1.0 suggested config

mason-nvim-dap.nvim 431

• Fix dart & flutter path on windows
• feat: support overriding filetypes for adapters

ltex_extra.nvim 110

• not assuming settings.ltex exist

This README is updated daily by a python script running in GitHub Actions

it-project-porkbellypro's Issues

Add register view

Process image in parallel

Deadline: 23/09

• Use web workers to offload Jimp onto a background thread

calling commit immediately after update does nothing

i think it's because of the fact that there's no time for setDetail to take place yet.

Implement home screen view

The home screen feature is the first page the users see once logged in. It is through this 'screen' that the cards will be shown in a grid format.

• Implement the card grid -- information received as prop from #54
  • implementing the card component
• Include contexts and mechanics for exposing the detail component from #6.
• Include universal search query logic onto the card grid based on intersection of keywords. SearchQuery received from App Context
• Be able to make GET calls for image thumbnails. #30

Fix ci bug for PR #45 & #43

Problem is that we can not reference the shared workspace in test. If we do, the test still runs fine locally but it fails in github.

Define tag component props

Implement registration endpoint -- POST @ api/register

Implement endpoint for user registration.
Passwords are already hashed at this point in the sequence by the client hence at no point that the password leaves the client software.

Ensure that:

• User input is free of any 'strange characters' consult team for details. Data sanitisation, escaping input or forcing a certain list of characters are potential starting ideas.
• Account duplicates are checked.

Add card detail component

Concerns the slide out panel for displaying card details, card editing form and new card entry forms. Components should contain all the buttons that will be hooked up to callbacks:

• Expansion and closing button that will call functions passed as props pertaining to the appearance of the panel on the page. See #14.
• Call the appropriate controller functions, implemented in #54.
• Buttons that control the state of the panel to allow for updating fields. And show that images can be changed
• Make GET requests to the server to retrieve images. #30

MongoDB object style UML

Create an Object style UML

UX prototype interview with prototype v2

Conduct at least 3 prototype interviews with individual external to the dev team. The result should allow for greater refined for the next (and probably final) iteration of the prototype.

• interview 1
• interview 2
• interview 3

---

Link to #33

Fix mongoose schema doing nothing.

Currently it's possible to create document in mongodb without the mandatory field. I don't think this is intentional.

Add /api/logout endpoint

Required because the token cookie is HttpOnly.

Update home view to consume tag query

Visual styles

• Make measurements
• #118
• #119
  • #116
  • #115
  • Home View
    • #112
    • CardDetails
      • #113
      • #114
  • #117
• Viewport meta tag
• Responsive design

Review version 1 of lo-fi prototype

Tag your name if you want to have a chat on the prototype, such as if you see something you want to put it or change. Leave a preferred time frame (especially the day of the week) if you want, otherwise I can look through the Universal Free Time. (hopefully before this Thursday)

Also feel free to add comments to the confluence or miro file.

Add delete card view

Add card keyword search

Covered by #14.

Add /api/tag PUT/PATCH/DELETE endpoints

• Update REST API docs
• Implement server-side routes
  • PUT /api/tag
  • PATCH /api/tag
  • DELETE /api/tag

Scroll card into view when selected to view detail

Expected behavior:

• 1. Once a card is clicked, it's locked, meaning it's y-position will not change.

• 2. User scrolling on the left side will unlock any locked card.

• 3. deselecting the card also unlock the card (though deselecting shouldn't change a locked card position).

• 4. if card grid's size is changed and no card is locked, the "scroll percentage" will be maintained (i.e. if it was at the very top, it'll stay there, if it was at the very bottom, it'll stay there, if it's anything in between, it'll scroll accordingly).

Implement login endpoint -- POST @ api/login

Implement end point for user login. If successful, a response with a cookie in the header that complements #24 scheme be sent back to the front end to set. For encryption, salt needs to allow #24 to decrypt cookie.

• Escaping inputs 👍
• Validate and extract appropriate user Id from the database
• Send an cookie encrypted with user data and session expiry duration.

Create tag picker component

Edit to picker presentation.
Add Tag text field doubles as a tag label filter. Remove colour selector but keep the add button.

Due 23rd September, 2021

Search card by keyword in field

Enable code coverage reports

Preliminary runs with coverage reports on shows that unit tests are missing a few code paths. May move this up to Sprint 1 if we have time.

Reference: https://jestjs.io/docs/configuration#collectcoverage-boolean

Implement app lifecycle

Task involves:

• Make the server serve the same page for all non-API and non-resource URLs
• GET /api/me on app load
• App lifecycle methods
  • Login
  • Logout
  • Register
  • update
  • showCardDetail
  • newCard
• Login page redirection
  • Redirect to /login from / if not signed in
  • Redirect to / from /login and /register if signed in
• Update buffers
  • Card update
  • CardField update
• Controller actions
  • Card commit
    • PUT /api/card if card is new
    • PATCH /api/card if card exists
  • Card delete (DELETE /api/card)
• Unit tests

Code infrastructure and boilerplate

Set up the project code structure so that everyone have something to work with. Leave comments about what frameworks we can use.

• Node.js 14.17
• npm 7
• TypeScript 4.3
• ESLint 7
• Express 4.17
• Webpack 5
• React 17
• @fluentui/react 8.28
• Mongoose 5

server does not accept empty string for mandatory field

also internal server error isn't printed

Implement user home page -- GET @ api/me

Implement 'user home page.'
Backend to return a user's data, including cards and tags managed by the user. Images will be fetched independently in #30.

Awaits on #24 for authentication and evaluation of user identity.

• Details sent to the client needs to be 'sanitised' to conceal DB or server structure (e.g Flattening nested structures or Objects).

Write integration tests for the server

Technically should be done in Sprint 1 but I don't want to let it drag on beyond the week of 06 September 2021.

https://github.com/supercharge/mongodb-github-action provides a means to establish a mongodb instance in GitHub Actions.

Due: 12th October, 2021

Integrations Test List:

• IN01
• IN02
• IN03
• IN04
• IN05
• IN06
• IN07
• IN08
• IN09
• IN10
• IN11
• IN12
• IN13
• IN14
• IN15
• IN16
• IN17
• IN18
• IN19
• IN20
• IN21
• IN22
• IN23
• IN23
• IN25

Create tag component

Add favorite cards feature

Define app context tag interfaces

Implement middleware for request size limit

Change API to send hash instead of hasImage

Deadline: 16/09

I think I simply change the hasImage field to a string instead of a boolean.

This is so that browser can differenciate between the different image properly and does not have to reload the image everytime

• Modify REST API docs
• Modify server route handlers
• Modify web controllers

Implement Image Upload -- api/card/image

Images of the business cards can be uploaded for each card stored. This functionality needs to be researched.
It has been decided that the backend will enforce a size limit of 1MB, and that the front end is to offer resizing capabilities for this purpose. Atlas cluster has 512MB size limit. This endpoint acts independently from card CRUD operations.

http://expressjs.com/en/4x/api.html#res.send outlines how files can be sent back to the client.
https://www.npmjs.com/package/mime library offers MIME support for node.

• Research how images can be stored on the database
• Decide on whether to allow size limit, compress, or use GridFS
• Edit schema to fit needs.
• Defining API in documentation

• implement endpoint in back end for POST
• implement endpoint in back end for GET

Implement app tag controllers

Implement Card Create Endpoint -- PUT @ api/card

Implement endpoint on backend to for PUT requests in order to store card details in system.
Assuming that middleware #24 is able to provide user for the data, the card details must be sanitised. Issues does not include having to handle image upload. See #30 for the details.

Revision 1 for lo-fi prototype

Based on reviews gathered from lo-fi prototype 1, begin integrating and refining the new ideas into the design. The finalised version of this iteration should be presentable for the client for their opinion.

mockup prototype v2 is complete, and ready for client to review.

Implement edit card endpoint -- PATCH api/card

Implement end point to take PATCH requests for updating a card's details.
Assuming that middleware #24 is able to provide user for the data, the card details must be sanitised. Issues does not include having to handle image upload. See #30 for the details.

#23 Has a similar structure.

Implement responsive design to UX prototype V2

Given that client has given a pass on the current (desktop only) version of the prototype, begin designing for different view ports sizes including for mobile and tablet view. The final version should suffice to allow front end development.

• mobile view
• tablet view
• ultrawide view

I hope this should be enough to start building the logical side of the front end. If there are some parts unclear on how it should be structured, let me know.

access link
https://www.figma.com/file/eTM4bPj4803ZOjXDyxsmOk/UX-prototype-v2.1?node-id=113%3A1447

UX prototype 2.1 changes:

• Bulk select removed
• Individual detail edit function accounts for both attribute and field
• Centered search bar for desktop view
• Add card button inside home view is removed
• CRUD control for image during card editing added
• Basic tablet view-port
• Changes to home view for mobile view-port
• Changes to card detail field layout for mobile view

The Card size changes for desktop view-port is yet to be implemented, because I have yet to find a suitable solution, and I didn't think it is necessary at this stage of our production.

Create Application Header Component

Concerns implementing components for header bar. Includes Search bar, add card button and profile dropdown. Suggested FluentUI components to check out are Split Button and SearchBars.

• Information on user login state is passed as a prop from App.
• Search Bar query string sets value in Context

Component triggers the following methods implemented by #54

• Profile Dropdown house a logout button that triggers logout.
• Add button triggers controller to construct a new card and loads the card into Context.

Add password reset view

This feature is extra as it is yet to be brought up by the client.

Add login view and register view

Task involves implementing login and registration form components. Redirection logic, login and registration api implementation will be handled by #54. Event handlers can call stub functions.

Add testing and CI

Project needs a unit/integration test pipeline and continuous integration.

Implement authentication middleware

Our system requires authentication of users in order to partition cards into views for each end user. This includes session management, and defining how session information is communicated between back and front ends.

Middleware will step in for requests accessing protect routes.

• An encrypted cookie will need to be resolved into a user id
• Resolved data to be validated
• Data finds a way to be passed to further middleware down the chain.

Home view tag list component

Add card detail view

Implement card deletion endpoint -- DELETE api/card

Implement endpoint for DELETE requests.
Given proper authentication and user details from #24, the card should be successfully deleted from the database.

Add card tags feature

Covered by #79, #80, #81, #82, #83, #84, #85, #86, #87

Add create card view

Hook Mongo Cluster onto Server backend

As @pep1032314 had created an Atlas Cluster, we would like to hook it into the back-end code.

This requires following the process on Atlas to obtain a connection string, with appropriate database credentials.

• Please do not disclose database access credentials here, or in the source code. Spread it via email and refer to it in the connection code through environmental variables. This environmental variable should also be sent to the deployment platform.

• The infrastructure is set up and the back-end is able to establish a connection to the cluster

• Implement updated models. See #16 for discussion

Branch db connection has been created for this purpose