Serve JavaScript modules via Django static files

Open
#63 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
django, javascript, python, react
Domain
backend, web-dev

Research direction

Start by reviewing Django's STATICFILES_FINDERS documentation and the original issue #4, then compare the proposed finder, collect_modules, and explicit-folder approaches. Done means selecting and implementing a deterministic integration that serves ReactPy JavaScript modules through Django's static-file system, with an explicit behavior for modules missing at startup.

Written by the indexing model from the issue text.

Description

blocked complexity: 2 (medium) priority: 3 (low) type: investigation
Current Situation

Currently, we serve our JavaScript web modules (JavaScript Components) via views. This is due to the fact that our current architecture does not let us know what web modules exist until runtime.

However, Django views are less efficient at serving files than a webserver such as Nginx or Apache.

Proposed Actions

Develop a way of integrating with the Django Static File system.

Work Items

We have a couple of paths we could take

  1. Create a static file finder that points to ReactPy's web modules directory
    • This is the preferred implementation if feasible
  2. Develop a collect_modules command, similar to django-compressor's collect_static command
    • This option requires changes in ReactPy to deterministically collect all JavaScript web modules during startup.
    • Also, what should we do if we accidentally did not obtain a static file during startup? Should we fallback to using our Django view, or just throw a 404 Not Found error?
  3. Make users put JavaScript modules in dedicated JAVASCRIPT_MODULES = [ ... ] folder(s)
    • User's will need to statically define their ReactPy JavaScript modules with this method.

See #4 for the original issue.

Dominant language
Python
Stars
357
Forks
22
Avg merge
10h 31m
Merged PRs (30d)
2

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from reactive-python/reactpy-django

All issues in reactive-python/reactpy-django

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.