Write better documentation
thedrummeraki opened this issue · 5 comments
All of the documentation will be living here. As of today, it is incomplete.
Below is a list of PRs that are responsible for documenting each aspect of the codebase
-
Mangadex::Api
-
Mangadex::Internal
-
Mangadex::Artist
-
Mangadex::Auth
-
Mangadex::Author
-
Mangadex::Chapter
-
Mangadex::ContentRating
-
Mangadex::CoverArt
-
Mangadex::CustomList
-
Mangadex::Manga
-
Mangadex::Relationship
-
Mangadex::ReportReason
-
Mangadex::ScanlationGroup
-
Mangadex::Tag
-
Mangadex::Upload
-
Mangadex::User
-
Mangadex::MangadexObject
-
Mangadex::Types
-
Mangadex::Version
You rule dude, will be looking into this for my project and helping add PRs whenever bugs are found.
Hey @royalgiant thank you! Let me know if you need any help with using the gem. I haven't updated it in a while since the Mangadex API doesn't change much, but I'm planning on going back soon to iron out certain things.
@thedrummeraki do you have any idea how to create a proxy to get the images through? Just learned that unless it's through a proxy, I cannot get the images from my deployed app on Heroku.
Hey there @royalgiant, I'm also having the same issue on mine :/ (https://dexify.herokuapp.com/mangas/browse). I think using a proxy service works well. I never personally bothered with writing one from scratch (though it would be pretty easy with a lightweight framework like Sinatra or NodeJS runtime).
I have a project where I came up with a solution to serve images through a route (on Rails), download the image and serve it. Not performant but a good workaround for that project in particular (see it in action here). It works well here because I'm lazy loading images, but may not work in the case of showing up a bunch of covers