Skip to content
Shruti Agarwal edited this page Jul 5, 2022 · 17 revisions

Terminologies🧐

Shiksha frontend is made up from the following four terminologies:

image

Components🖊️

Everything inside the page will be a component, and there will be a rule that if any component is reused more than two times then it will be pushed to the shiksha-ui package.

Screenshot from 2022-07-05 11-05-38 Screenshot from 2022-07-05 11-05-28

Pages📜

Pages are the navigational parts of the module. The page generally indicates the complete information of one of the pieces/feature of the module. Example: View Worksheet, Question Bank will be the two separate pages in the worksheet module. At this stage, we can test the efficiency of the design system to analyze if all the components are independent.

pages

Module📘

Module is a combination of one or more pages indicating the particular functionality which can be used in the following ways:

  • As a standalone Unit.
  • Can be integrated in the Shiksha Application.
  • Can be integrated in third party applications using Iframe or Web View.

Each module has its own configurations and colour palette. Modules can also use exposed components from other modules.

pages pages

Application📚

Application is composed of many feature modules such as teacher app consists of Attendance Module, Worksheet Module, Notification Module etc.

Example: https://sandbox.shikshaplatform.io/