search

dreipol / djangocms-spa-vue-js

Run your django CMS project as a single-page application (SPA) with vue.js and vue-router.
MIT License
59 stars 9 forks source link

djangocms-spa-vue-js in combination with vue-fetch-route #3

Open jverbeet opened 6 years ago

jverbeet commented 6 years ago

Description

As I love to work with Django and Django CMS, I noticed your git repos and medium posts. The idea of a Django CMS backend and Vue.js frontend to have a full-fletched single page application is really useful for a project I'm working on.

However, the limited documentation makes it really hard to get started. It's really unclear how this django repo works together with vue-fetch-route and djangocms-spa.

I noticed this GitHub repo where you provided a boilerplate for the backend. Using this boilerplate I managed to get the backend up and running. However, the front-end part remains unclear.

Do you mind extending that repo with sample code for the front-end? As I understand this might take some of your time, I'm willing to contribute to these repos with more in-depth documentation for future reference 😄 (e.g. a getting started).

Let me know what you think

nirazul commented 6 years ago

@jverbeet: Thanks for showing interest in our modules! Surely, our intention is to make these modules more accessible to all users. We left the documentation quite barebone for the moment as you can never be sure how much traction, if at all, open source modules gain.

As the maintainer of vue-fetch-route, I'll be happy to update the boilerplate project with frontend code. You could support us by pointing out as to where the documentation is lacking (the most) or specifically at which step you had problems moving forward.

jverbeet commented 6 years ago

Thanks for your response. There were a couple of things I was struggling with when setting up this project. Firstly, I wasn't particularly familiar with the architecture of a SPA based application and how that influences Django and Vue.js. Secondly, it took me a while to figure out there were multiple repos (vue-fetch-route, djangocms-spa, djangocms-spa-vue-js) and how they work together. These two things combined made it hard to get me started, after which I luckily found that repo that I referenced earlier in one of the issues.

To improve this it would be nice to have a centralised documentation where:

Let me know what you think and at which step I can help.

nirazul commented 6 years ago

@jverbeet First of all, sorry for being unresponsive for such a long time.

I've started working on a repository that unifies all backend and frontend components and should work as a showase. I've forked the repository you've referenced and added just the barebone frontend parts that are necessary.

It's not finished yet but I'm confident that I will have a working example by the end of the next week: djangocms-test

After the showcase is running, I will create a step by step guide for the project. Parallel to that we can probably improve the documentation of the existing plugins to clarify what is what and what goes where.

nirazul commented 6 years ago

The basic example is now up and running! As barebone as it is, I hope it helps you getting the impression how things work. There's still much to do, documentation wise, of course. Also some bigger features like partials are not yet visible in the example.

jverbeet commented 6 years ago

Hi,

Thanks for your response nonetheless. I'll check it out later this week and I might have some time to prepare a Pull Request into that repository.