fancy-flashcard / ffc

Fancy Flashcard - Lightweight free/libre and open-source PWA to help you learning on all your devices
https://fancy-flashcard.github.io/ffc/
GNU General Public License v2.0
20 stars 9 forks source link

Consider to connect the Third Party Decks Component to our Deck Collection Repo #55

Open michael-spengler opened 3 years ago

michael-spengler commented 3 years ago

e.g. by displaying all decks in here: https://github.com/fancy-flashcard/deck-collection/tree/main/wirtschaftsinformatik

FischerRene commented 3 years ago

As described in the contributing information, everyone can create a pull request to request a deck to be added. Some more information on our thoughts behind can be found in the docs.

You only have to add a new object to the third-party-decks.json.

The deck type (as described in the docs) can be a special type ('official', 'curated' and 'sponsored') and without any icon.

nikolockenvitz commented 3 years ago

I generally also like the idea of including those decks directly in the app. I would prefer to have all of the decks in one file (one file can include multiple decks) so that this will only be one entry in the third party decks (e.g. Wirtschaftsinformatik - DHBW Mannheim). I would prefer it this way as the topics are very context specific and related to the lectures. My proposal for next steps are the following:

Depending on how much quality improves, I would be okay with having it as a curated deck, otherwise I would go for a normal third party deck.

FischerRene commented 3 years ago

I generally also like the idea of including those decks directly in the app. I would prefer to have all of the decks in one file (one file can include multiple decks) so that this will only be one entry in the third party decks (e.g. Wirtschaftsinformatik - DHBW Mannheim). I would prefer it this way as the topics are very context specific and related to the lectures. My proposal for next steps are the following:

  • in your content repository, add all the decks there into one large file (maybe do this with a script so that iterative work on the decks can still be done in the small files and you just need to run the script again to get the overall file)

This seems like a good idea. I propose you add a pipeline that not only combines the decks, but also opens a PR if the repository gets updated. But for this to work best, I'd also suggest you add an approval process for decks to be added to the main branch, to avoid mistakes like the ones Niko mentioned as well as spelling mistakes.