Skip to content

Introduction

Harshil Jani edited this page Aug 12, 2022 · 1 revision

Welcome to the generator-create-rc-admin wiki!

The generator is part of C4GT (Code 4 Gov Tech) which is about making Digital Product Goods in Government Technology. In 2022, The first Cohort was pitched and were being trained in an effective manner. The generator connects the bridge between the CRUD APIs that comes from Sunbird-RC and the FrondEnd which is a React and Next.js app named as X-Admin.

The generator currently has two instances which could be generated.

  1. A general purpose Admin based on REST or GraphQL
  2. An Admin for Sunbird-RC's generated CRUD APIs.

The general-puspose admin comes with a json-server and json-graphql-server servers so, APIs needs to be local. But, You can write your own data provider and make the best use out of it.

The Sunbird Admin comes with a dataprovider compatible for the CRUD APIs being generated by Sunbird-RC. Providing just the url generates the Admin completely from the source.

image

The basic flow of use case goes as per the above diagram.

Sunbird-RC :

One of the task of this building block is to generate the CRUD based APIs and create the electronically verifiable registries. They use the files written in JSON-LD which are known as Schemas. Based on these Schemas the CRUD APIs are being generated.

Shiksha :

The Shiksha Platform has the Dashboard or say a FrontEnd for the CRUD APIs which are being used by Educational , HeathCare etc. bodies. The X-Admin is one such admin where the Educational entities are being displayed by the Shiksha-Platform.

Generator-RC :

The Generator was planned to be able to update the CRUD APIs by updating the Schema and the X-Admin both. But currently, We can update the CRUD-APIs from the Admin and Update the Admin from the APIs using a Config file which is responsible for the data being reflected on the Admin.