From 6dd9ed4abed139e1402b4331c2847419a219fbf2 Mon Sep 17 00:00:00 2001 From: Adi-204 Date: Mon, 23 Dec 2024 16:06:35 +0530 Subject: [PATCH 1/3] Update on Dockerfile Implementation for Windows Users --- Dockerfile | 1 + INSTALLATION.md | 80 +++++++++++++++++++++++++++++++++---------------- 2 files changed, 55 insertions(+), 26 deletions(-) diff --git a/Dockerfile b/Dockerfile index ed9ac7892..d3a2d8055 100644 --- a/Dockerfile +++ b/Dockerfile @@ -5,6 +5,7 @@ WORKDIR /app COPY package*.json ./ RUN apk add --update git && \ + corepack enable && \ git init && \ git submodule init && \ git submodule update && \ diff --git a/INSTALLATION.md b/INSTALLATION.md index be3b2cb03..5c2aadb01 100644 --- a/INSTALLATION.md +++ b/INSTALLATION.md @@ -4,31 +4,41 @@ This guide provides step-by-step instructions for installing the JSON Schema Web ## Table of Contents -1. [Setting Up the Project](#setting-up-the-project) - - [Requirements](#requirements) - - [Cloning the Repository](#cloning-the-repository) - - [Setting Up Environment Variables](#setting-up-environment-variables) -2. [Corepack Configuration](#corepack-configuration) - - [What is Corepack?](#what-is-corepack) - - [Installing Corepack](#installing-corepack) - - [Using Corepack with This Project](#using-corepack-with-this-project) - - [Updating Yarn Version](#updating-yarn-version) - - [Troubleshooting](#troubleshooting) -3. [Post-Configuration Steps](#post-configuration-steps) - - [Installing Dependencies](#installing-dependencies) - - [Running the Development Server](#running-the-development-server) - - [Building Static Files](#building-static-files) -4. [Testing](#testing) - - [Running Tests](#running-tests) - - [Test Coverage](#test-coverage) - - [Writing Tests](#writing-tests) -5. [Code Quality](#code-quality) - - [Formatting](#formatting) - - [Linting](#linting) - - [Husky for Git Hooks](#husky-for-git-hooks) -6. [Run locally using Docker](#docker-deployment) - - [Prerequisites](#prerequisites) - - [Steps](#steps) +- [JSON Schema Website: Installation and Development Guide](#json-schema-website-installation-and-development-guide) + - [Table of Contents](#table-of-contents) + - [Setting up Project](#setting-up-project) + - [Configuration](#configuration) + - [Requirements](#requirements) + - [Cloning the repository](#cloning-the-repository) + - [Setting Up Environment Variables](#setting-up-environment-variables) + - [Corepack Configuration](#corepack-configuration) + - [What is Corepack?](#what-is-corepack) + - [Installing Corepack](#installing-corepack) + - [Using Corepack with This Project](#using-corepack-with-this-project) + - [Updating Yarn Version](#updating-yarn-version) + - [Troubleshooting](#troubleshooting) + - [Post-Configuration Steps](#post-configuration-steps) + - [Installing Dependencies](#installing-dependencies) + - [Running the Development Server](#running-the-development-server) + - [Building Static Files](#building-static-files) + - [Testing](#testing) + - [Running Tests](#running-tests) + - [Opening Cypress Test Runner](#opening-cypress-test-runner) + - [Running All Tests Headlessly](#running-all-tests-headlessly) + - [Test Coverage](#test-coverage) + - [E2E Test Coverage](#e2e-test-coverage) + - [Component Test Coverage](#component-test-coverage) + - [Full Test Coverage](#full-test-coverage) + - [Writing Tests](#writing-tests) + - [Code Quality](#code-quality) + - [Formatting](#formatting) + - [Linting](#linting) + - [Husky for git hooks](#husky-for-git-hooks) + - [pre-commit hook](#pre-commit-hook) + - [Run locally using Docker](#run-locally-using-docker) + - [Prerequisites:](#prerequisites) + - [Windows Users Steps:](#windows-users-steps) + - [Mac/Linux Users Steps:](#maclinux-users-steps) ## Setting up Project @@ -274,7 +284,25 @@ If you are a Docker lover, you have the option to use it following these instruc After cloning repository to your local, perform the following steps from the root of the repository. -#### Steps: +#### Windows Users Steps: +1. Build the Docker image: + ```bash + docker build -t app . + ``` + +2. Install dependencies inside the container: + ```bash + docker run --rm -it -v "${PWD}:/app" app sh -c "yarn install" + ``` + +3. Start the container: + ```bash + docker run --rm -it -v "${PWD}:/app" -p 3000:3000 app + ``` + +Note: ${PWD} refers to the current working directory on your system. This ensures that your local project folder is mounted to the /app directory inside the container. + +#### Mac/Linux Users Steps: 1. Build the Docker image: ```bash make install From 2e769f0d2cc3f61a3081f63d53284bd73455cc24 Mon Sep 17 00:00:00 2001 From: Adi-204 Date: Thu, 26 Dec 2024 15:42:00 +0530 Subject: [PATCH 2/3] Revert "Update on Dockerfile Implementation for Windows Users" This reverts commit 6dd9ed4abed139e1402b4331c2847419a219fbf2. --- Dockerfile | 1 - INSTALLATION.md | 80 ++++++++++++++++--------------------------------- 2 files changed, 26 insertions(+), 55 deletions(-) diff --git a/Dockerfile b/Dockerfile index d3a2d8055..ed9ac7892 100644 --- a/Dockerfile +++ b/Dockerfile @@ -5,7 +5,6 @@ WORKDIR /app COPY package*.json ./ RUN apk add --update git && \ - corepack enable && \ git init && \ git submodule init && \ git submodule update && \ diff --git a/INSTALLATION.md b/INSTALLATION.md index 5c2aadb01..be3b2cb03 100644 --- a/INSTALLATION.md +++ b/INSTALLATION.md @@ -4,41 +4,31 @@ This guide provides step-by-step instructions for installing the JSON Schema Web ## Table of Contents -- [JSON Schema Website: Installation and Development Guide](#json-schema-website-installation-and-development-guide) - - [Table of Contents](#table-of-contents) - - [Setting up Project](#setting-up-project) - - [Configuration](#configuration) - - [Requirements](#requirements) - - [Cloning the repository](#cloning-the-repository) - - [Setting Up Environment Variables](#setting-up-environment-variables) - - [Corepack Configuration](#corepack-configuration) - - [What is Corepack?](#what-is-corepack) - - [Installing Corepack](#installing-corepack) - - [Using Corepack with This Project](#using-corepack-with-this-project) - - [Updating Yarn Version](#updating-yarn-version) - - [Troubleshooting](#troubleshooting) - - [Post-Configuration Steps](#post-configuration-steps) - - [Installing Dependencies](#installing-dependencies) - - [Running the Development Server](#running-the-development-server) - - [Building Static Files](#building-static-files) - - [Testing](#testing) - - [Running Tests](#running-tests) - - [Opening Cypress Test Runner](#opening-cypress-test-runner) - - [Running All Tests Headlessly](#running-all-tests-headlessly) - - [Test Coverage](#test-coverage) - - [E2E Test Coverage](#e2e-test-coverage) - - [Component Test Coverage](#component-test-coverage) - - [Full Test Coverage](#full-test-coverage) - - [Writing Tests](#writing-tests) - - [Code Quality](#code-quality) - - [Formatting](#formatting) - - [Linting](#linting) - - [Husky for git hooks](#husky-for-git-hooks) - - [pre-commit hook](#pre-commit-hook) - - [Run locally using Docker](#run-locally-using-docker) - - [Prerequisites:](#prerequisites) - - [Windows Users Steps:](#windows-users-steps) - - [Mac/Linux Users Steps:](#maclinux-users-steps) +1. [Setting Up the Project](#setting-up-the-project) + - [Requirements](#requirements) + - [Cloning the Repository](#cloning-the-repository) + - [Setting Up Environment Variables](#setting-up-environment-variables) +2. [Corepack Configuration](#corepack-configuration) + - [What is Corepack?](#what-is-corepack) + - [Installing Corepack](#installing-corepack) + - [Using Corepack with This Project](#using-corepack-with-this-project) + - [Updating Yarn Version](#updating-yarn-version) + - [Troubleshooting](#troubleshooting) +3. [Post-Configuration Steps](#post-configuration-steps) + - [Installing Dependencies](#installing-dependencies) + - [Running the Development Server](#running-the-development-server) + - [Building Static Files](#building-static-files) +4. [Testing](#testing) + - [Running Tests](#running-tests) + - [Test Coverage](#test-coverage) + - [Writing Tests](#writing-tests) +5. [Code Quality](#code-quality) + - [Formatting](#formatting) + - [Linting](#linting) + - [Husky for Git Hooks](#husky-for-git-hooks) +6. [Run locally using Docker](#docker-deployment) + - [Prerequisites](#prerequisites) + - [Steps](#steps) ## Setting up Project @@ -284,25 +274,7 @@ If you are a Docker lover, you have the option to use it following these instruc After cloning repository to your local, perform the following steps from the root of the repository. -#### Windows Users Steps: -1. Build the Docker image: - ```bash - docker build -t app . - ``` - -2. Install dependencies inside the container: - ```bash - docker run --rm -it -v "${PWD}:/app" app sh -c "yarn install" - ``` - -3. Start the container: - ```bash - docker run --rm -it -v "${PWD}:/app" -p 3000:3000 app - ``` - -Note: ${PWD} refers to the current working directory on your system. This ensures that your local project folder is mounted to the /app directory inside the container. - -#### Mac/Linux Users Steps: +#### Steps: 1. Build the Docker image: ```bash make install From c4c6a9a542fdec939666bd6fabf332cc86bea977 Mon Sep 17 00:00:00 2001 From: Adi-204 Date: Fri, 27 Dec 2024 14:16:37 +0530 Subject: [PATCH 3/3] Add protoc-gen-jsonschema --- data/tooling-data.yaml | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/data/tooling-data.yaml b/data/tooling-data.yaml index 17449638b..710113da9 100644 --- a/data/tooling-data.yaml +++ b/data/tooling-data.yaml @@ -3034,3 +3034,16 @@ source: 'https://github.com/andreineculau/json-schema-random' license: 'Apache-2.0' status: 'obsolete' + +- name: protoc-gen-jsonschema + description: 'JsonSchema generator plugin for Google Protocol Buffers' + toolingTypes: ['model-to-schema'] + languages: ['Protocol Buffers'] + maintainers: + - name: 'Uanid' + username: 'uanid' + platform: 'github' + license: 'Apache-2.0' + source: 'https://github.com/pubg/protoc-gen-jsonschema' + supportedDialects: + draft: ['4', '6', '7', '2019-09', '2020-12'] \ No newline at end of file