torchbox / storybook-django Goto Github PK

Hi there,

I am a bit confused tho I am familiar with Django.

Currently I use django-tailwind which requires me to create a separate theme app inside my Django project.

I like to build a UI component library so that

1. the components can be reused within the same Django project
2. and then eventually I can make it reusable across all Django projects that also use django-tailwind

Given this in mind, do I still follow the instructions given here to first install django-pattern-library followed by the npm installation of storybook-django and selecting HTML for the storybook template?

Describe the bug

When I start this project to demo its capabilities, it does not proxy the rendered markup into storybook.

I have the Django project running and the storybook running.

Environment

Mac Sonoma
Python 3.9.18

Steps to reproduce

(Write your steps here:)

1. Clone or download code for project
2. python -m venv --prompt sb .venv
3. source .venv/bin/activate
4. pip install -r requirements.txt
5. npm install
6. python manage.py runserver 0:8001
7. npm run start

Expected behavior

I expected to be able to navigate the Storybook and see the components

Actual behavior

I receive this error in Storybook Error occurred while trying to proxy: localhost:6006/pattern-library/api/v1/render-pattern

How tightly coupled is this with React ? I'm reading through the code but I'm having trouble seeing what would need to be done to get it working with Vue.

The README includes a broken link for contributing referencing https://github.com/torchbox/storybook-django/blob/main/CONTRIBUTING.md

How do I set up the storybook-django project locally to explore?

I have been experimenting and trying to solve my own issues and after a while I am beginning to grok.

The storybook-django is solely for those who want to use a client side framework like React to work with Django via REST.

If I have no intention of using a client-side and use purely serverside rendering, I should stick to pattern-library.

In other words, pattern-library is your attempt at providing a storybook for server side rendering?

Did I get that right?

I have finished the installation for django-pattern-library.

i have finished with npx and npm install commands.

Then i see a copy demo/storybook into the project. Copy to where exactly?

And why do I need to copy given that i already npm install storybook-django?

Is your proposal related to a problem?

This would be nice to document in here so we have a clear example of how to do this with Storybook.

Describe the solution you’d like

Add documentation about this in the README. Technically 99% of the implementation on this is from DPL and has nothing to do with Storybook, but it’d be nice to document this with the Storybook syntax in JS nonetheless.

Currently in the "late alpha" phase according to https://storybook.js.org/blog/first-class-vite-support-in-storybook/.

THink best to indicate that Yes to proceed and No to manually choose storybook project