|
| 1 | +# Super Comic Slicer |
| 2 | + |
| 3 | + |
| 4 | +## Brief |
| 5 | +An artist's long comic page cutter into their desired webcomic platform. |
| 6 | + |
| 7 | +### Features |
| 8 | +- Drag&Drop and Click to Upload |
| 9 | +- Drag to Re-Organise |
| 10 | +- Webcomic platform options available: Webtoon and more soon! |
| 11 | +- File extensions options: JEPG, and PNG available |
| 12 | +- Scale to optimize (or expand to lossless pixels) |
| 13 | +- Zip folder |
| 14 | + |
| 15 | +**Sample** |
| 16 | + |
| 17 | + |
| 18 | +### Supports |
| 19 | +#### Demographic |
| 20 | +For the general public and artists. |
| 21 | + |
| 22 | +#### Browser Compatibility |
| 23 | +For modern browsers. |
| 24 | + |
| 25 | +#### A11y |
| 26 | +- Color accessible |
| 27 | + |
| 28 | +Screenreaders will not be supported. |
| 29 | + |
| 30 | +#### PWA |
| 31 | +- Service Worker [PENDING] |
| 32 | +- Offline app experience [PENDING] |
| 33 | + |
| 34 | +### Target Devices |
| 35 | +- tablet |
| 36 | +- desktop (Window Desktop App WIP via Tauriel) |
| 37 | + |
| 38 | +## Development Setup |
| 39 | +Consider the following when contributing: |
| 40 | +- Maintenance and versioning update |
| 41 | +- Better UI experience |
| 42 | +- Optimizations |
| 43 | +- Bug fixes |
| 44 | +- Testing |
| 45 | + |
| 46 | +### Installations |
| 47 | + |
| 48 | +``` |
| 49 | +npm install |
| 50 | +``` |
| 51 | + |
| 52 | +Note: I work on windows, so cross-env is required to be implemented in the future. |
| 53 | + |
| 54 | +## Feedbacks |
| 55 | +Send me an DM here: [email protected] |
| 56 | + |
| 57 | +## TODO List |
| 58 | + |
| 59 | +### Phases |
| 60 | + |
| 61 | +#### Phase #1 |
| 62 | +- [ ] Same working features as old design. |
| 63 | +- [ ] New design |
| 64 | +- [ ] fix broken social media links |
| 65 | + |
| 66 | +#### Phase #2 |
| 67 | +- [ ] Add File Name Edits feature |
| 68 | +- [ ] i18n; translations request |
| 69 | + - [ ] FR - French |
| 70 | + - [ ] JP - Japan |
| 71 | + - [ ] KR - Korean |
| 72 | + - [ ] DE - German |
| 73 | + - [ ] CH - Chinese |
| 74 | + - [ ] PH - Filipino |
| 75 | + - [ ] ID - Indonesia |
| 76 | + - [ ] SP - Spanish |
| 77 | +- [ ] Fix up service Worker |
| 78 | +- [ ] testing |
| 79 | + |
| 80 | +Note: Add public Google Sheet link here. |
| 81 | + |
| 82 | +#### Phase #3 |
| 83 | +- [ ] Add About Page |
| 84 | + - [ ] About description |
| 85 | + - [ ] Video Tutorial Guide |
| 86 | + |
| 87 | +#### Phase #4 |
| 88 | +- [ ] Move to Tauriel to make available as desktop app |
| 89 | + |
| 90 | +### Development Notes |
| 91 | +- [ ] warning feature for mobile size is not available |
| 92 | +- [ ] Loader for main page startup |
| 93 | +- [ ] testing (storybook, jest or playwright) |
| 94 | + |
| 95 | +- Add eslint |
| 96 | +- Add JS config for pathway naming easier |
| 97 | +- add testing (storybook, jest or playwright) |
| 98 | + |
| 99 | +Fixes |
| 100 | +- [ ] add node environment only to run service worker in prod build |
| 101 | +- [ ] setup environment to work from "secure origin" |
| 102 | +- [ ] cross-env environment ?? |
| 103 | +- [x] switch to dnd-kit (OR Use Gesture) and for animation use auto-animate |
| 104 | +- [ ] refactor File Extenion and Squash radio options. They both could be reused. |
| 105 | +- [ ] Refactor the Checkbox and input Style. They are some repeated. |
| 106 | +e.g. |
| 107 | + - CheckboxTextInput.scss |
| 108 | + - WebcomicInputSelect |
| 109 | +- [ ] on unselected radio or checkbox, the value should be removed else it may get effected in processing the result. |
| 110 | + |
| 111 | +Optimizations: |
| 112 | +- use MemoryRouter for testing, excluding Browser history. |
| 113 | +- use Memo for the re-renders |
| 114 | +- use useCallback on functions to prevent re-renders |
| 115 | + |
| 116 | +User Experience: |
| 117 | +- [ ] loading component |
| 118 | +- [ ] sw |
| 119 | + |
| 120 | +NOTE: |
| 121 | +- dnd-kit has 1* moderate severity vulnerability. |
| 122 | + |
| 123 | +## FAQ |
| 124 | +Q. How large can a file be in client side? |
| 125 | + |
| 126 | +Internet Explorer v9 - v11, Chrome, Safari, Edge, and Firefox support the HTML5 uploader, which has a max 4GB file size limit. |
| 127 | + |
| 128 | +Both Chrome and Edge support folder uploads. |
| 129 | + |
| 130 | +Web browsers are limited by available memory, CPU utilization, network performance, and numerous other factors. |
| 131 | + |
| 132 | +Q. Can you drag a folder full of image? |
| 133 | + |
| 134 | +No. |
| 135 | + |
| 136 | +It is a possible next Update Consideration: |
| 137 | + |
| 138 | +- [Upload folder and all its content in JavaScript](https://stackoverflow.com/questions/42239663/upload-folder-and-all-its-content-in-javascript) |
| 139 | + |
| 140 | +Q. Can you have more than one single file? |
| 141 | + |
| 142 | +Assume it won't connect from a new image file given, instead it start a newslicing process. |
0 commit comments