Port `threads` app templates to Django template syntax

[brylie]

We want to simplify the CiviWiki project by removing JavaScript SPA code in Backbone.js and using Django templates instead. We will work through the Backbone templates in the threads app to convert the template syntax from Backbone to Django. We want to maintain the visual styling. Below is a checklist of the relevant Backbone templates to be ported to complete this task.

Note: Backbone markup is written between {% verbatim %} and {% endverbatim %} template tags.

Task

Port the following template from Backbone to Django view/template syntax.

• [ ] convert API views to Django views (if necessary)

  • [ ] new_thread
  • [ ] get_thread
  • [ ] get_civi
  • [ ] get_civis
  • [ ] get_responses
  • [ ] create_civi
  • [ ] rate_civi
  • [ ] edit_civi
  • [ ] delete_civi
  • [ ] edit_thread
  • [ ] upload_civi_image
  • [ ] upload_thread_image

• [ ] threads app shouldn't use Django REST framework

  • [ ] remove threads/api.py file

• [ ] threads app should contain only Class Based Views

  • [ ] convert Functıon Based Views to CBVs
  • [ ] convert ViewSets to CBVs

• [ ] all templates in threads app should

  • [ ] work without any JavaScript (Backbone.js)
  • [x] use only Django template syntax, such as {% for solution in solutions %}

• [ ] all templates in threads app should not contain any

  • [x] Backbone.js template syntax, such as {{# _.each(solutions, function (s) { }}
  • [x] verbatim tags
  • [x] backbone_templates block content

[sreejithliterally]

@brylie I would like to work on this issue, can I give it a try? Btw I'm a beginner

[brylie]

@sreejithdikru, sure. I'll assign you to the task. Please let us know if you have any difficulty with Backbone or Django templates. We can co-assign another person to the issue to assist.

[wassafshahzad]

Hi @brylie I have gone over this issue and this is more complex then I first thought. I will create further issue after breaking this down into independent steps

[AmarDeepak]

@brylie I am highly interested to work on this as it is one of my daily tasks to migrate applications from other languages to python frameworks like Django, Flask, FASTAPI, and so on.

[brylie]

@AmarDeepak, your help would be much appreciated! Porting from Backbone to Django templates syntax is our most challenging task currently :smile:

[AmarDeepak]

@brylie - Thanks for assigning this task to me. This weekend I will try to finish as much as I can. My availability maybe a concern as I have to finish my own office work.

[edwardjimi]

Hi, I would like to get involved with helping CiviWiki. Could I help? I'm currently learning Python and Java Script on Code Cademy but have no experience with Backbone or Django.

[brylie]

@edwardjimi, thanks for your interest. Let's give @AmarDeepak some time to see how they progress.

[edwardjimi]

Thanks for getting back to me @brylie. Happy to help where and when needed.

[parimalakettymuthu]

@brylie - looking for a task.. though beginner to Python but having little work experience in other languages.

[brylie]

Thanks, @parikvinu. This is a somewhat challenging task since we need to convert templates from Backbone to Django syntax and prepare the template context in Django views. Would you like to give it a try?

[parimalakettymuthu]

@brylie - sure. Can give it a try. Are there any sample templates to refer to?

[brylie]

@parimalakettymuthu basically, we can create the templates from scratch or borrow from the existing Backbone code, which is primarily HTML. We can use the Django documentation for reference related to the Django template syntax.

[LexxLuey]

Is this issue still open?

[brylie]

@LexxLuey, yes.

[LexxLuey]

Please assign the task to me. I would love to contribute. I have time on my hands

[brylie]

Thanks @LexxLuey! Feel free to make the threads app from scratch rather than wrestling with the Backbone code.

[godfreyJo]

Here to give a helping hand

[brylie]

Thanks @godfreyJo. @LexxLuey, how can @godfreyJo be of assistance?

[LexxLuey]

Oh most definately... is there a medium where we can have an online meet concerning the task @godfreyJo @brylie?

[LexxLuey]

@brylie he can help me rewrite the view for the page. @godfreyJo, is it possible to sync up anytime soon via a virtual meet?

[godfreyJo]

@LexxLuey I am okay, I wonder if you are okay for a quick one in the next 10 minutes. you can schedule and share the link: godfreyoyugi@gmail.com

[abdz-128]

Hi, I am new here looking for easy open source projects. Willing to help out in Python and Cpp.

[brylie]

Welcome @abdz-128

Please feel free to introduce yourself here:

https://github.com/CiviWiki/OpenCiviWiki/discussions/995

[abdz-128]

@brylie Okay Introduced myself over there

[ksharma20]

Is there something, I can help with, too ? @brylie

[gorkemarslan]

I'd like to take over this task.

[gorkemarslan]

@brylie, I will move accounts/feed.html file to threads app. Then I will port the template to Django template syntax. The template basically renders thread list, trending issues, draft threads, etc.

I am planning to create ThreadListView to render this template. In this case, I will rename the template file to thread_list.html or threads.html. I can also keep using FeedView. What do you think of the naming?

[brylie]

Thanks that will help. :smiley:

I'm heading to bed now, but I'll check for more comments ASAP.

[Nehemiah60]

Hello, @brylie. I see this issue is still open. Also, I have gone through the codebase, and the issues have not been fixed yet. Can you assign me, please?

[Nehemiah60]

Hello, @brylie. I think the only task is deleting the api.py file in the threads app. All the other tasks seem to be completed.

[brylie]

@gorkemarslan, can you confirm the status of this issue?

[Nehemiah60]

I will take this @brylie. I will make the necessary changes where necessary

[chickenleaf]

hello @brylie , is this issue or any other issue that is beginner open source friendly up for grabs? i love this project!!