Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
AdelBeit authored Jun 12, 2024
1 parent fede7e3 commit b3b31cf
Showing 1 changed file with 19 additions and 2 deletions.
21 changes: 19 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,5 +26,22 @@ Designed to work **offline**.

#### WIP FEATURES:

- Ability to upload multiple pictures at once
- Ability to edit (heal) portions of schedule the OCR couldn't fully recognize
- ✅ Ability to upload multiple pictures at once
- ⚒ Ability to edit (heal) portions of schedule the OCR couldn't fully recognize

### TECHNICAL DECISIONS

I decided to work with vanilla js and keep tooling and third party lib/frameworks to a minimum. I wanted to provide the fastest load time possible which meant reducing the js code that's shipped to client as much as possible.

I realize that I could use react or svelte as well as typescript, those would provide better DX and maintanability. But I recognize the scope of this project is small, there is not much room for adding new updates or having other people work on it. Plus codebase is modularized pretty well so it will be relatively easy to add a new transformer or take parts of the code for other projects and for those reasons I didn't see the need to add heavy libraries just so I could have a fancy state manager or 20 small components for a very simple app.

Although I have to acknowledge that towards the end I have faced difficulties managing the state and fixing errors and kind of wish I went with svelte or something to make it all easier, but I think it's still very manageable and once I implement the healing feature I will probably not touch this code again as it will just work always. So I stand by my decision.


### CHALLENGES & LESSONS LEARNED

#### Processing and organizing shift information from screenshot

#### Managing state with nothing but vanilla js

#### Managing visual UI state with tailwind

0 comments on commit b3b31cf

Please sign in to comment.