sandrina-p / website

JSON Schema website

👋 Welcome to the JSON Schema website

This repository contains the sources of JSON Schema website:

• It's powered by Next.js,
• It uses Tailwind CSS framework,
• It's build and deployed with Netlify.

Run locally

Requirements

Use the following tools to set up the project:

Node.js v20.9.0+

Cloning the repository

This project uses git submodules, so you will need to run the following commands to fully clone the repo.

git submodule init
git submodule update

Install dependencies

Install dependencies

yarn

Run the development server

Run the development server on http://localhost:3000

yarn dev

Build static files

Build static files on /out folder

yarn build

Project structure

This repository has the following structure:

  ├── .github                     # Definitions of GitHub workflows, pull request and issue templates
  ├── components                  # Various generic components such as "Button", "Figure", etc.
  ├── data                        # JSON Schema Implementations.
  ├── styles                      # Various CSS files
  ├── lib                         # Various JS code for preparing static data to render in pages
  ├── pages                       # Website's pages source. It includes raw markdown files and React page templates.
  │    ├── overview               # JSON Schema initiative docs
  │    ├── blog                   # Blog posts
  │    ├── learn                  # JSON Schema docs
  │    └── implementations        # Various pages to describe tools
  ├── public                      # Data for site metadata and static blog such as images
  ├── next.config.js              # Next.js configuration file

Contribute

Here are some areas where you can contribute to the website:

• Blogs posts
• Case Studies
• Design
• Documentation
• Website enhancements
• Add a new JSON Schema Implementation
• JSON Schema Landscape

To figure out a good first issue to work on, join our Slack workspace and visit the #contribute channel. This channel is specifically designed for onboarding and supporting new contributors.

You should also check out our Contributing guidelines.

Contributors

Thanks goes to these wonderful people who contributed to this website:

_{Made with contributors-img.}

Financial Contributors

Become a financial contributor and help us sustain our community. [Contribute]

Connect with the JSON Schema Community

Inspired by

This document has been inspired by AsyncAPI website README.md.

License

The contents of this repository are licensed under either the BSD 3-clause license or the Academic Free License v3.0.