From 181b5100cd84f42064c6c79478322b4a45144d21 Mon Sep 17 00:00:00 2001 From: Marukome0743 Date: Sun, 31 Dec 2023 00:36:26 +0900 Subject: [PATCH 1/2] =?UTF-8?q?=F0=9F=93=9Ddocs:=20add=20devcontainer=20se?= =?UTF-8?q?ction?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 42 +++++++++++++++++++++++++++++++++++++++--- 1 file changed, 39 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 5aa217bd..1c03b9c8 100644 --- a/README.md +++ b/README.md @@ -22,13 +22,16 @@ react - tailwindcss + tailwindcss typescript - vscode + vscode + + + vscode License @@ -38,7 +41,7 @@ Multi-experience program to learn programming with nature🌄

-## 📃 Usage +## 📃 Get Started To clone and run this application, you'll need [Git](https://git-scm.com) and [Bun](https://bun.sh/) installed on your computer. From your command line: @@ -72,6 +75,39 @@ $ bunx @biomejs/biome check --apply-unsafe ** Once opening, you can run `Extensions: Show Recommended Extensions` to install the recommended extensions for good development is automatically configured. +## 🐳 Dev Containers + +A **dev container** is a running container with a well-defined tool/runtime stack and its prerequisites. +You can try out development containers with **[GitHub Codespaces](https://github.com/features/codespaces)** or **[Visual Studio Code Dev Containers](https://aka.ms/vscode-remote/containers)**. + +### Setting up the development container + +
+GitHub Codespaces +Follow these steps to open this project in a Codespace: +1. Click the <> Code ▽ drop-down menu. +2. Click on the **Codespaces** tab. +3. Click **Create codespace on main**. + +For more info, check out the [GitHub documentation](https://docs.github.com/en/free-pro-team@latest/github/developing-online-with-codespaces/creating-a-codespace#creating-a-codespace). +
+ +
+VSCode Dev Containers +If you already have VSCode and [Docker](https://www.docker.com/) installed, you can click the badge above or [here](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/OpenUp-LabTakizawa/caravan-kidstec) to get started. +Clicking these links will cause VSCode to automatically install the Dev Containers extension if needed, clone the source code into a container volume, and spin up a dev container for use. + +Follow these steps to open this project in a container using the VSCode Dev Containers extension: + +1. If this is your first time using a development container, please ensure your system meets the pre-reqs (i.e. have Docker installed) in the [getting started steps](https://aka.ms/vscode-remote/containers/getting-started). + +2. To use this repository, open a locally cloned copy of the code: + + - Clone this repository to your local filesystem. + - Press F1 and select the **Dev Containers: Open Folder in Container...** command. + - Select the cloned copy of this folder, wait for the container to start, and try things out! +
+ ## 🫶 Contribute Want to report a bug, contribute some code, or improve the documentation? Excellent! From 7f92ab5c0bfb16faaf7157394b0c0653fe19a541 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E3=83=9E=E3=83=AB=E3=82=B3=E3=83=A1?= Date: Sun, 31 Dec 2023 00:49:11 +0900 Subject: [PATCH 2/2] =?UTF-8?q?=F0=9F=93=9Ddocs:=20add=20devcontainer=20se?= =?UTF-8?q?ction?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 1c03b9c8..3cc1c241 100644 --- a/README.md +++ b/README.md @@ -84,16 +84,19 @@ You can try out development containers with **[GitHub Codespaces](https://github
GitHub Codespaces -Follow these steps to open this project in a Codespace: -1. Click the <> Code ▽ drop-down menu. -2. Click on the **Codespaces** tab. + +Follow these steps to open this project in a Codespace: +1. Click the **Code** drop-down menu. +2. Click on the **Codespaces** tab. 3. Click **Create codespace on main**. For more info, check out the [GitHub documentation](https://docs.github.com/en/free-pro-team@latest/github/developing-online-with-codespaces/creating-a-codespace#creating-a-codespace). +
VSCode Dev Containers + If you already have VSCode and [Docker](https://www.docker.com/) installed, you can click the badge above or [here](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/OpenUp-LabTakizawa/caravan-kidstec) to get started. Clicking these links will cause VSCode to automatically install the Dev Containers extension if needed, clone the source code into a container volume, and spin up a dev container for use. @@ -106,6 +109,7 @@ Follow these steps to open this project in a container using the VSCode Dev Cont - Clone this repository to your local filesystem. - Press F1 and select the **Dev Containers: Open Folder in Container...** command. - Select the cloned copy of this folder, wait for the container to start, and try things out! +
## 🫶 Contribute