Skip to content

Doc Generator

Chakshu Gautam edited this page May 31, 2022 · 16 revisions

GovTech Context

Most of the government workflows end up with a document that shows the key metrics that officers can take actions on. For example a school assessment report which can be printed and stuck to the notice board of school. A report card which can be verified digitally (like COWIN) with PDF as output is a good example for the same.

Product Explanation

Doc generator is a plugin-based service that will help in generating reports, docs, pdfs, from various data sources and in any required format and layout. The Design Doc can be found here.

Features to be Implemented

  1. Implementing a Template and Doc Management admin that allows for the creation of templates and creating a pipeline for connecting it with a plugin. A react based app created from scratch.
    • Creating a playground similar to regex101 that allows for creation of templates and render them realtime with sample data based on every field type that is supported.
    • Auto generation of sample data based on just template
    • Doc creation workflow management - Creation -> Iteration -> Saving etc. Additional features like making them live and managing multiple versions of the same doc.
    • View existing docs created from a template rendered in the admin itself without the need to download them. Should also show the data used to generate the doc for audit purposes.
    • Simple Dashboards out of metabase to be embedded to show metrics on usage
    • Add sample docs to play around with as part of the installation
    • Documentation on how to use the admin.
  2. Deployment workflow to be created using Github Actions
  3. Single script to setup the whole module with frontend admin and backend without the need to start up services.

Learning Path

Category Rating
Difficulty **
Risk/Exploratory ***
Core Development **
Skills Django, React, PSQL
Mentor Manav
Project size 200 hours
Clone this wiki locally