From 1ec905c629467b35f2471cd75a5f38129eaa9ba2 Mon Sep 17 00:00:00 2001 From: Pradumna Saraf Date: Wed, 4 Oct 2023 11:33:11 +0530 Subject: [PATCH] docs: add a instruction --- site/docs/intro/getting-started.mdx | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/site/docs/intro/getting-started.mdx b/site/docs/intro/getting-started.mdx index 8d95529d..db7dcab7 100644 --- a/site/docs/intro/getting-started.mdx +++ b/site/docs/intro/getting-started.mdx @@ -31,7 +31,8 @@ You can read more about the Preevy [origin story and motivation](/intro/motivati ## Prerequisites -- Docker and Docker Compose V2 installed. +- Node.js installed. +- Docker and Docker Compose V2 installed. ## Getting Started @@ -66,7 +67,9 @@ Preevy is designed to be easy to use, with an API smiliar to [Docker Compose](ht ```bash preevy up ``` -
+ +**Note:** Make sure you the repo/project you are working and running the `preevy up` command from is a git initialized repo and at least one commit has been made. This is required for Preevy to create a unique preview environment name. + :::info Cloud provider credentials Managing and provisioning preview environments in Preevy, requires access and credentials to a cloud provider or Kubernetes cluster. Currently AWS, GCP, Azure and Kubernetes are supported, but more providers are [coming soon](/roadmap#more-cloud-drivers).