Example html code

[smithdc1]

Hi @django-crispy-forms/core-team

I'm wondering if it's worth us putting the html being generated by the latest release of django-crispy-forms into this repo? And maybe serve it through gh pages?

My thinking is that it could be useful to see the html 'a clean' project created. It would be helpful to assess issues raised as we can compare expected Vs experienced? Having to load the project up to do this is a bit of a pain?

[bryan-brancotte]

I think it could be a good idea, from https://github.com/JamesIves/github-pages-deploy-action I understand that we could push on a dedicated branch html file produced rendered by a temporary django server, and then configure pages to server on this branch.

[smithdc1]

Hi Bryan, That sounds like a great idea. I'll investigate and get back to you. Wonder if we could do something with PR's on the main repo too......

…

On Thu, 24 Oct 2019, 12:16 bryan brancotte, ***@***.***> wrote: I think it could be a good idea, from https://github.com/JamesIves/github-pages-deploy-action I understand that we could push on a dedicated branch html file produced rendered by a temporary django server, and then configure pages to server on this branch. — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#15?email_source=notifications&email_token=AJM6IOQYH4CVXENNTN6SYMTQQF7YLA5CNFSM4JEPH3KKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOECEVHEI#issuecomment-545870737>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AJM6IOTKAWC5AVW4NIX4LYTQQF7YLANCNFSM4JEPH3KA> .

[bryan-brancotte]

Indeed It could also be nice, but I am wondering the amout of time we will use to set it up compared to its utility. Never the less, the initial idea of having it as a showroom of what crispy does is nice.

[bryan-brancotte]

In the case of a showroom, maybe #1 with heroku is still a valide solution

[smithdc1]

Thanks for your link earlier. I've been doing some research.

• There is a python deployment action 👍
  https://github.com/marketplace/actions/deploy-to-github-pages-python

• This just leaves creating the html
  Could we use django.test.client to create the HTML, and somehow save it to a file on the server. Maybe a small file script to run the django.test.client and save the output.

Thoughts? Am I crazy!?

[smithdc1]

So a little update on this. I have had a lot of fun trying to progress this over the last few days.

I've managed to build a tool which on push or on pull-request triggers the following

1. build of a virtual environment
2. runs the tests
3. generates the crispy-test-project sites and saves the html
4. an index.html page is built which links to all of the sites
5. pushes to the gh-pages branch
6. publish the website

Here is a link

The integration with the PR is also quite nice (here)[https://github.com/smithdc1/pull/5]. Please excuse the 'mess' of the change long, scroll to the bottom of the page (keep going).

However, there is a show stopper with this. It only works on PRs from the same repo. Currently the permissions fail (for security reasons) with a PR from a fork. Maybe in time GH will look to address this.

At least the journey was enjoyable.

[ckrybus]

Hi @smithdc1,

I've started working on a template pack overview site hosted on Github Pages. It's 70% done - it needs to be polished and a few template packs are missing/need to be cleaned up, it's more like a MVP right now, but you can see it already live here https://ckrybus.github.io/crispy-test-project/

How does it work?

• generate a static site with https://github.com/meeb/django-distill/
• deploy it on push with Github Actions to Github Pages

The code is here main...ckrybus:crispy-test-project:main
It includes also my PR #33 which has been open for over a year.

Right now the header is template pack specific, later we could maybe make it an iframe toolbar or something so that it looks exactly the same for all pages, etc.

Ideally I would like to merge it with the crispy-test-project, the url would be then https://django-crispy-forms.github.io/crispy-test-project/.

1. Is it something you or the other maintainers are willing to merge (after it has been polished)?
2. Is this project still maintained / are you looking for maintainers? Bulma PR is open, I also saw that bootstrap5 is already implemented, it probably only needs to be a little updated.

[smithdc1]

Hi @ckrybus

I think of this as a mini test project which folk can use to test their template packs. Having a branch on your fork seems the way to go rather than pushing those changes upstream? Likely your project will move at your own pace and I shouldn't be in the way of that?

[ckrybus]

I'm trying to create something like "djangopackages.org" for django-crispy-forms + preview functionality known from many template directories so I can compare the bulma template pack to others, but it is not bulma specific. In my opinion the main value is the template pack preview functionality, because probably something like 99% of django-crispy-forms users use an existing template pack. That said, while (re)writing crispy-bulma the crispy-test-project was indeed very helpful 👍

So that's my goal. Then I will keep it in my repo for now. Thanks for the quick reply!