Skip to content

Commit

Permalink
More ideas
Browse files Browse the repository at this point in the history
  • Loading branch information
vmandic committed Jan 29, 2024
1 parent 4ad92bd commit 802510b
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions TODO.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,25 +10,26 @@ This document is just rough flow of ideas I will get to document in one place so
- [ ] CHORE/DEVUX/QA: add git commit hooks with husky to run linters
- [ ] CHORE/DEVUX/QA: switch backend to TypeScript
- [ ] CHORE/DEVUX/QA: switch frontend to TypeScript (and some build system like bun)
- [ ] CHORE/DEVUX/QA: add some kind of spell checker utility for all kinds of files while coding in vscode?
- [ ] FEAT: change index and crawl HTML pages to be rendered from a template engine like handlebars/nunjucks etc, build a layout with header, body and footer
- [ ] FEAT/BRANDING: add version info + git hash of a latest deployment and a link to latest release from Github to a page footer
- [ ] FEAT/SEO: replace GA, add page visitor analytics with seogets tool
- [ ] FEAT/UX: figure a way to stop the crawler process if the user navigates away or signals a stop, maybe keep sending a heartbeat signal the client is connected ie. interested in results
- [ ] FEAT: remove cheerio to send the HTML page request, replace with fetch and add a retry to fetch with some logic to the retry attempts
- [ ] FEAT/UX: add a proxy support to increase the changes of passing by protection, eg. smartproxy.com looks nice
- [ ] CHORE/DEVUX: make the Github CI action have a manual step to make the fly.io deployment from main head ie. job in question
- [ ] add support for finding links based on custom elements, eg. span.eu site uses Umbraco which does not have a single `<a></a>` in their HTML source, so doing this with an additional env config value could be very cool
- [ ] FEAT: add support for finding links based on custom elements, eg. span.eu site uses Umbraco which does not have a single `<a></a>` in their HTML source, so doing this with an additional env config value could be very cool
- [ ] DEVUX/QA: add Dockerfile HEALTHCHECK for better fly.io integration
- [ ] QA: add Sentry.io integration (works with fly.io nicely seems so, they have it in the UI somehow)

## Product

- [ ] UX: add an input on index.html to allow end user to specify a target URL
- [ ] UX: infer HTTP or HTTPS, loosen the way the user specifies the domain eg. google.com or www.google.com or https://www.google.com, do some preflight checks to find the proper one before starting
- [ ] SEO: count words of the actual HTML page and list them out as a valuable metric for the end user
- [ ] UX: results breakdown: after finishing crawling print a an overview of the process like total sucessful links, dead links, HTTP code breakdown, avg/median etc
- [ ] UX: results breakdown: after finishing crawling print a an overview of the process like total successful links, dead links, HTTP code breakdown, avg/median etc
- [ ] UX: add a file download at the end of crawling run of a .csv file which can offer selected (configured) columns per .env settings, file should get auto deleted with a separate worker after 1 minute
- [ ] UI/UX: choose a color and font scheme, apply to index and crawl pages

## Other

Non so far.
- [ ] EPIC: rewrite to C#, Blazor & .NET, I do not even need to start on explaining this :-)

0 comments on commit 802510b

Please sign in to comment.