dwyl / dwyl/image-classifier

EPIC: Prepare the repo for `public` share on `HN` πŸš€

Open
#22 5 comments 1 reaction 1 assignee Claimed by @LuchoTurtle View on GitHub
chore documentation epic priority-1 T4h
Dominant language
Jupyter Notebook
Stars
35
Forks
6
PR merge metrics
No merged PRs in 30d

Description

@LuchoTurtle you've done a _superb_ job of building a _fully functional_ image captioning app! 😍 πŸŽ‰
Now it's time to get some `credit` for it πŸ’³ πŸ˜‰ by submitting a "**Show HN**" :shipit:
And in the process **raise your `public` profile** for applying to `#NextAdventure` πŸš€

# Todo

+ [x] Address the start-up time (currently `25sec`): https://github.com/dwyl/image-classifier/issues/20
+ [ ] And/or create an endpoint to serve a `1x1px GIF` to start the app _proactively_ when someone is reading the `README.md` ref: https://github.com/dwyl/ping/issues/7

+ [x] Improve the `Why?` section of `README.md` to answer the Reader's question succinctly.

Currently it's: https://github.com/dwyl/image-classifier/tree/a3c8c3bf79a0f5e7bca160b6e460d883bc6e3973#why-
image

This is _good_ for an _internally-focussed_ tutorial for _us_ ... πŸ‘
but as an LLM-curious person casually reading on `HN`, πŸ‘€
this isn't going to "hook" me into reading a `5k word` tutorial for `30+ mins` ... ⏳

```md
# Why? πŸ’­

We needed a fully-offline capable (no 3rd party APIs/Services) image captioning service
using a state-of-the-art pre-trained image model to describe images uploaded in our
[`App`](https://github.com/dwyl/app).

# What?

A step-by-step tutorial building a fully functional
`Phoenix LiveView` web application that allows anyone
to upload an image and have it described
by the `Open Source` `BLIP` image captioning (`Large`) model.

```

+ [x] Simplify layout of homepage of the App and add _examples_: https://github.com/dwyl/image-classifier/issues/7
+ [x] _Prepare_ Intro/Demo `GIF`: https://github.com/dwyl/image-classifier/issues/21
+ [x] Add demo `GIF` to intro of `README.md`
+ [x] `GIF` should be below the `badges` and _above_ the `TOC`:

intro-gif-position

+ [ ] Record Tutorial `Video`: #23

## Part 2

+ [ ] Study the 20 most successful "Show HN" posts: https://hn.algolia.com/?query=show+hn&sort=byPopularity (spend 1-2 mins skimming each one to extract the info - or use `ChatGPT` to do some pre-analysis if you think it will be useful ...)
Summarise what you learned as comments in this issue thread. πŸ’¬ πŸ™

+ [ ] Carefully craft your `Show HN` Title to maximise its chance of success. πŸ’­
+ [ ] Share on https://elixirforum.com/ to get some initial traction/stars.
+ [ ] As soon as you submit on HN, update the `Elixir Forum` topic to include the `HN` link to drive up-votes.
+ [ ] Submit your `Show HN`!! πŸš€
+ [ ] Share the link so we can up-vote it. πŸ”— ⬆️
+ [ ] Get _everyone_ you know to up-vote it so it gets and initial boost. πŸ“ˆ

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.