GSoC 2025: Adaption of component library in JSON Schema website and completion of test suite development

[DhairyaMajmudar]

Brief Description

The goal of this project is to adapt generalised UI components library for JSON Schema website.

1. JSON Schema website consists of several components, including.... different kinds of accordions, cards, buttons, banners, tables, etc.... All of these components are custom developed by this project we look forward to changing a modern UI component library. This will not only reduce the developers' hassle of creating new custom components from scratch or to debug/modify the existing components but will also give a new and modular look to our website.

2. JSON Schema docs section content is currently in markdown syntax which is rendered on the website pages. There are many instances where we need to have some custom markdown components to showcase particular kinda information. These custom markdown components currently lie in a single file StyledMarkdown.tsx. The components of these files can be segregated into different components files which makes it easy to debug/modify. Other than these common components such as tables, tab groups, etc... can be directly received from UI components library.

3. Completion of developing an enhanced test suite for the website. The task of creating a test suite was initialised last summer during GSoC'24 program. But later on, new components kept on adding as of which currently the website has partial test coverage of the components. By means of this project, we also aim to overall completion of the test suite. More information on the issue can be obtained here.

Expected Outcomes

By the completion of GSoC coding time period we expect all above tasks to be completed.

Skills Required
Familiarity with Nextjs, Typescript, test suite development using Cypress, a good overview and knowledge of JSON Schema website codebase.

Mentors

TBD

Expected Difficulty
medium-Hard

Expected Time Commitment
350 hours

[Honyii]

Thanks a lot for your project idea submission Dhairya.

[Karan-Palan]

This seems like a great project and need of the hour. Great idea!

[rishabhknowss]

I really like this idea! If it gets accepted in GSoC, I would love to work on it. I suggest using ShadCN for the UI components, as it aligns well with modern, customizable design needs and is widely adopted by many open-source organizations. Additionally, improving the CI/CD pipeline, refining Docker configurations, and completing issue #806 would be great additions to this proposal