litestar-org / litestar-fullstack

Litestar Fullstack Reference Application with React, Vite, SQLAlchemy, Docker, Task Queues, and more!
https://fullstack.litestar.dev/
MIT License
329 stars 55 forks source link

Docs: Better explanations of how things work #35

Open pboes opened 1 year ago

pboes commented 1 year ago

Hi, I'm looking for a cross of Diango and FastAPI (read "Django building experience but lean and with first class pydantic and openapi support). Litestar and this repo in particular look like a great start but as somebody spoiled by Dingo abstracting away a lot of the backend, I'm wondering whether there can be a simple guide for how to use this repo coming from Django without having to learn all about SQLAlchemy etc. Or maybe you'd recommend a different stack? I assume many people looking to migrate from django to litestar will aim to do so via this repo.

Thanks


[!NOTE]
While we are open for sponsoring on GitHub Sponsors and OpenCollective, we also utilize Polar.sh to engage in pledge-based sponsorship.

Check out all issues funded or available for funding on our Polar.sh Litestar dashboard

  • If you would like to see an issue prioritized, make a pledge towards it!
  • We receive the pledge once the issue is completed & verified
  • This, along with engagement in the community, helps us know which features are a priority to our users.

Fund with Polar

v3ss0n commented 1 year ago

i will help with this this weekend.

nathanielarking commented 1 year ago

I'm in the same spot here! Migrating from Django to Litestar and while the Litestar docs are great at the moment, there isn't a lot on how to structure an application. This repo is helpful so far but I would find it more helpful if there was more explanation, so we can understand why things are being done the way they are.

Articles like this one were very helpful to me learning Django in the first place.

dkout commented 1 year ago

+1 here. Not necessarily Django migration, but an article explaining how things work and why certain choices were made would be very useful. Thanks!

AgarwalPragy commented 1 year ago

+1 here. Not necessarily Django migration, but an article explaining how things work and why certain choices were made would be very useful. Thanks!

Absolutely! An article explaining the directory structure, why certain choices were made, and how to make changes would be amazing!

Funding this issue with 100$

Fund with Polar

@JacobCoffee for some reason, the 100$ bounty I placed doesn't show up on https://polar.sh/litestar-org Is polar.sh configured only for the main repo? Can you please check if the core maintainers of Litestar will get the bounty for this issue? Thanks.

peterschutt commented 1 year ago

I can confirm we can see this in polar. Watch the issue for updates - thanks for your pledge!