Create an interface to deal with item list

niamtokik commented 1 year ago

At this time, all items are added manually (or with the help of an elisp script). That's annoyingly not efficient. In fact, it's even counterproductive, when we need to update the file, it takes a really long and painful moment to do so. The idea is to extract only the required information, if possible from a textual database stored in the repository (we can call it state file) and with the help of few script, fetch automatically all information required to generate the awesome list. The minimal information required are:

[ ] url of the repository, containing where the repository is stored (github, gitlab...) with the user/owner and the name of the repository. That's all we need to fetch more information by using github api
[ ] hex.pm project if present. Few projects did not have the same
[ ] erlang.mk index path of the project if present (see https://github.com/ninenines/erlang.mk/tree/master/index)

NOTE: application and libraries present directly in OTP tree are also quite important. A way to collect their information should also be used.

What we could generate:

[ ] one comprehensive line containing the name of the project and its description
[ ] more information containing:
- [ ] when the project was created
- [ ] who created the project
- [ ] different kind of information like followers, numbers of issues and so on
- [ ] documentation links
- [ ] CI/CD pipelines (if it exists)
- [ ] articles, podcast or talks about this application
- [ ] badges from shields.io (but it will probably require to fetch them manually and store them in the documentation, with more tha 100+ applications, the pages takes a while to be loaded OR we can reuse directly the information from github/gitlab API, but it will need to be updated on demand)

Few tests were done during the last days

niamtokik commented 1 year ago

Here another example of static page without loading made for poolboy, using only ascii and unicode. The idea is to generate README.md file with this kind of templates using github, gitlab, hex.pm and other API.

pros: fast loading, easy to parse, easy to search, generate an history of modification/update
cons: crappy code, not last information (will require a job with automatic push or automatic pr), API complexity, secret management (youtube api is not public for example)

Here the sample for poolboy:

poolboy: A hunky Erlang worker pool factory.

- Repository: https://github.com/devinus/poolboy - Documentation: https://hexdocs.pm/poolboy/ - Build: https://app.travis-ci.com/github/devinus/poolboy/pull_requests - Support: https://gratipay.com/devinus/ - License(s): UNLICENSE, ISC
| [Github](https://github.com/devinus/poolboy) | license | contributors | last-commit | open issues | stars | forks | repo-size | watchers | |--------| :-----: | :------------: | :-----------: | :-----------: | :-----: | :-----: | :---------: | :--: | | | 🟢
ISC | 🟢
[26](https://github.com/devinus/poolboy/graphs/contributors) | 🔴
[october 2018](https://github.com/devinus/poolboy/commit/master) | 🟡
[21](https://github.com/devinus/poolboy/issues) | 🔵
1.5k | 🔵
347 | 🔵
3.42MB | 🔵
74 | | [Hex.pm](https://hex.pm/packages/poolboy) | version | licenses | downloads | downloads/week | download/day | | :-----: | :--------: | :--------: | :---------: | :--------------: | :------------: | | | 🔵
1.5.2 | 🔵
Apache 2.0 | 🟢
69M | 🟢
101k | 🟢
20k |

Here the sources:


  - <details><summary><b><a
    href="https://github.com/devinus/poolboy">poolboy</a></b>: A hunky
    Erlang worker pool factory.</summary><br/>

    - Repository: https://github.com/devinus/poolboy
    - Documentation: https://hexdocs.pm/poolboy/
    - Build: https://app.travis-ci.com/github/devinus/poolboy/pull_requests
    - Support: https://gratipay.com/devinus/
    - License(s): UNLICENSE, ISC
    <br/>

    | [Github](https://github.com/devinus/poolboy) | license | contributors | last-commit | open issues | stars | forks | repo-size | watchers |
    |--------| :-----: | :------------: | :-----------: | :-----------: | :-----: | :-----: | :---------: | :--: |
    |        | 🟢<br/>ISC  | 🟢<br/>[26](https://github.com/devinus/poolboy/graphs/contributors) | 🔴<br/>[october 2018](https://github.com/devinus/poolboy/commit/master) | 🟡<br/>[21](https://github.com/devinus/poolboy/issues) | 🔵<br/>1.5k | 🔵<br/>347 | 🔵<br/>3.42MB | 🔵<br/>74 |

    | [Hex.pm](https://hex.pm/packages/poolboy) | version  | licenses | downloads | downloads/week | download/day |
    | :-----: | :--------: | :--------: | :---------: | :--------------: | :------------: |
    |        | 🔵<br/>1.5.2 | 🔵<br/>Apache 2.0 | 🟢<br/>69M | 🟢<br/>101k | 🟢<br/>20k | 

    </details>

niamtokik commented 1 year ago

Here a model using bbmustache to load automatically templates present in priv/templates: https://github.com/erlang-punch/awesome-erlang/blob/dev/awesome/awesome/src/awesome_template.erl

erlang-punch / awesome-erlang

Create an interface to deal with item list #1