Opened 17 months ago

Last modified 12 months ago

#30296 assigned New feature

Add how-to guide for JavaScript frameworks integration

Reported by: Maciej Olko Owned by: Josef Rousek
Component: Documentation Version:
Severity: Normal Keywords: javascript, rest, api, assets
Cc: Triage Stage: Accepted
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no


Question "How do I get Django and my JS framework to work together?" is common question being searched on the Internet {1}{2} so it should be vital to have at least introduction to this topic in Django's documentation.

How-to guide would consist of two parts (B and C original descriptions by Ayeric Augustin {3}):

  1. Consider brief introduction how to make JSON response, what is a REST API and link to API creation Django Packages grid?
  1. Singe Page App model description — where Django only serves the API

We would need to explain CORS and CSRF in the clearest terms possible. Many devs end up shotgun-debugging CORS or CSRF errors, which always results in insecure deployments. (…) Perhaps a condensed version of Django React SPA Aymeric's blog post {4} could do the job? (…)

  1. Description of integrating a modern JS framework with django.contrib.staticfiles

(…) The docs should at least give the general idea of "compile your frontend to somewhere Django can find the files, then run collectstatic".

Discussion on django-developers:



Change History (4)

comment:1 Changed 17 months ago by Carlton Gibson

Triage Stage: UnreviewedAccepted

Accepting, yes. This kind of guide would be great I think. (I guess the difficulty is pitching it exactly right, but that's implementation... 🙂)

comment:2 Changed 16 months ago by Josef Rousek

Owner: changed from nobody to Josef Rousek
Status: newassigned

comment:3 Changed 12 months ago by Tapasweni Pathak

Hello folks: Can I take the ticket or the ticket is for internal folks?

comment:4 in reply to:  3 Changed 12 months ago by Josef Rousek

Replying to tapaswenipathak:

Hello folks: Can I take the ticket or the ticket is for internal folks?

Hi there. Feel free to take it. I created a repo with basic guide, but haven't got back.

Note: See TracTickets for help on using tickets.
Back to Top