Skip to content

Commit 6dd9ed4

Browse files
committed
Update on Dockerfile Implementation for Windows Users
1 parent 8676fc2 commit 6dd9ed4

File tree

2 files changed

+55
-26
lines changed

2 files changed

+55
-26
lines changed

Dockerfile

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ WORKDIR /app
55
COPY package*.json ./
66

77
RUN apk add --update git && \
8+
corepack enable && \
89
git init && \
910
git submodule init && \
1011
git submodule update && \

INSTALLATION.md

Lines changed: 54 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -4,31 +4,41 @@ This guide provides step-by-step instructions for installing the JSON Schema Web
44

55
## Table of Contents
66

7-
1. [Setting Up the Project](#setting-up-the-project)
8-
- [Requirements](#requirements)
9-
- [Cloning the Repository](#cloning-the-repository)
10-
- [Setting Up Environment Variables](#setting-up-environment-variables)
11-
2. [Corepack Configuration](#corepack-configuration)
12-
- [What is Corepack?](#what-is-corepack)
13-
- [Installing Corepack](#installing-corepack)
14-
- [Using Corepack with This Project](#using-corepack-with-this-project)
15-
- [Updating Yarn Version](#updating-yarn-version)
16-
- [Troubleshooting](#troubleshooting)
17-
3. [Post-Configuration Steps](#post-configuration-steps)
18-
- [Installing Dependencies](#installing-dependencies)
19-
- [Running the Development Server](#running-the-development-server)
20-
- [Building Static Files](#building-static-files)
21-
4. [Testing](#testing)
22-
- [Running Tests](#running-tests)
23-
- [Test Coverage](#test-coverage)
24-
- [Writing Tests](#writing-tests)
25-
5. [Code Quality](#code-quality)
26-
- [Formatting](#formatting)
27-
- [Linting](#linting)
28-
- [Husky for Git Hooks](#husky-for-git-hooks)
29-
6. [Run locally using Docker](#docker-deployment)
30-
- [Prerequisites](#prerequisites)
31-
- [Steps](#steps)
7+
- [JSON Schema Website: Installation and Development Guide](#json-schema-website-installation-and-development-guide)
8+
- [Table of Contents](#table-of-contents)
9+
- [Setting up Project](#setting-up-project)
10+
- [Configuration](#configuration)
11+
- [Requirements](#requirements)
12+
- [Cloning the repository](#cloning-the-repository)
13+
- [Setting Up Environment Variables](#setting-up-environment-variables)
14+
- [Corepack Configuration](#corepack-configuration)
15+
- [What is Corepack?](#what-is-corepack)
16+
- [Installing Corepack](#installing-corepack)
17+
- [Using Corepack with This Project](#using-corepack-with-this-project)
18+
- [Updating Yarn Version](#updating-yarn-version)
19+
- [Troubleshooting](#troubleshooting)
20+
- [Post-Configuration Steps](#post-configuration-steps)
21+
- [Installing Dependencies](#installing-dependencies)
22+
- [Running the Development Server](#running-the-development-server)
23+
- [Building Static Files](#building-static-files)
24+
- [Testing](#testing)
25+
- [Running Tests](#running-tests)
26+
- [Opening Cypress Test Runner](#opening-cypress-test-runner)
27+
- [Running All Tests Headlessly](#running-all-tests-headlessly)
28+
- [Test Coverage](#test-coverage)
29+
- [E2E Test Coverage](#e2e-test-coverage)
30+
- [Component Test Coverage](#component-test-coverage)
31+
- [Full Test Coverage](#full-test-coverage)
32+
- [Writing Tests](#writing-tests)
33+
- [Code Quality](#code-quality)
34+
- [Formatting](#formatting)
35+
- [Linting](#linting)
36+
- [Husky for git hooks](#husky-for-git-hooks)
37+
- [pre-commit hook](#pre-commit-hook)
38+
- [Run locally using Docker](#run-locally-using-docker)
39+
- [Prerequisites:](#prerequisites)
40+
- [Windows Users Steps:](#windows-users-steps)
41+
- [Mac/Linux Users Steps:](#maclinux-users-steps)
3242

3343

3444
## Setting up Project
@@ -274,7 +284,25 @@ If you are a Docker lover, you have the option to use it following these instruc
274284

275285
After cloning repository to your local, perform the following steps from the root of the repository.
276286

277-
#### Steps:
287+
#### Windows Users Steps:
288+
1. Build the Docker image:
289+
```bash
290+
docker build -t app .
291+
```
292+
293+
2. Install dependencies inside the container:
294+
```bash
295+
docker run --rm -it -v "${PWD}:/app" app sh -c "yarn install"
296+
```
297+
298+
3. Start the container:
299+
```bash
300+
docker run --rm -it -v "${PWD}:/app" -p 3000:3000 app
301+
```
302+
303+
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.
304+
305+
#### Mac/Linux Users Steps:
278306
1. Build the Docker image:
279307
```bash
280308
make install

0 commit comments

Comments
 (0)