django-components/sampleproject/README.md

Sample Django project with django_components

Installation

1. Prepare virtual environment:

   python -m venv .venv
   source .venv/bin/activate
   

2. Install dependencies:

   pip install -r requirements.txt
   

Development server

python manage.py runserver

The app will be available at http://localhost:8000/.

Serving static files

Assuming that you're running the dev server with DEBUG=True setting, ALL static files (JS/CSS/HTML/PY) will be accessible under the /static/ URL path.

Production server

1. Prepare static files

   python manage.py collectstatic
   

2. Set DEBUG = False in settings.py.

3. Start server with gunicorn

   gunicorn sampleproject.wsgi:application
   

The app will be available at http://localhost:8000/.

Serving static files

This project uses WhiteNoise to configure Django to serve static files even for production environment.

Assuming that you're running the prod server with:

1. DEBUG = False setting
2. "django_components.safer_staticfiles" in the INSTALLED_APPS

Then Django will server only JS and CSS files under the /static/ URL path.

You can verify that this is true by starting the prod server and then navigating to:

• http://127.0.0.1:8000/static/calendar/calendar.js
• http://127.0.0.1:8000/static/calendar/calendar.css
• http://127.0.0.1:8000/static/calendar/calendar.html
• http://127.0.0.1:8000/static/calendar/calendar.py