From 75c7e6ff0e3e7a95bf74ce7eb56182b1ec7563c5 Mon Sep 17 00:00:00 2001 From: Administrator <admin@example.com> Date: Fri, 23 Sep 2022 14:24:57 +0000 Subject: [PATCH] Update README.md --- README.md | 30 +++++++++++++++++++++++++++--- 1 file changed, 27 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 9ed872f..9d61acb 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,39 @@ This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app). -# Using VS Code Devcontainer +## Using VS Code Devcontainer -Go to [Wiki - Setup Guide](https://gitlab.stratpoint.dev/devcontainers/project-wiki/-/wikis/Setup-Guide) +### For quick setup using Docker Desktop + +Go to [Project Wiki - Quickstart Guide](https://gitlab.stratpoint.dev/devcontainers/project-wiki) + +### For more manual setup without using Docker Desktop + +Go to [Project Wiki - Setup Guide](https://gitlab.stratpoint.dev/devcontainers/project-wiki/-/wikis/Setup-Guide) + +## Developing and Deploying inside Devcontainer + + + +There are two ways to open this project: + +1. Clone this project and open VS Code, and it should ask you to re-open the project in a container, if it finds the .devcontainer folder. +2. Without cloning the project, you can open the VS Code Command Palette, and run `Clone Repository in Container Volume...`. + + + +<br/> + + +The first time you do this, it may take a little while as it needs to build the Docker image. After the first load, each time you open the project, it should be much quicker (Unless you change the Dockerfile). + +You are now using the Dev Container in VS Code. When you open the terminal, you are inside the container. Plugins are running inside the container too. ## Getting Started -First, run the development server: +First, run the development server inside VS Code Terminal (CTRL + `): ```bash npm run dev -- GitLab