Skip to content

Commit

Permalink
docs: add a instruction (#241)
Browse files Browse the repository at this point in the history
  • Loading branch information
Pradumnasaraf authored Oct 4, 2023
1 parent 65580ce commit cd541ec
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions site/docs/intro/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -66,7 +67,9 @@ Preevy is designed to be easy to use, with an API smiliar to [Docker Compose](ht
```bash
preevy up
```
<br />

**Note:** Preevy uses the git repo at the current directory to calculate a stable environment ID for your project. Make sure a git repo is initialized (with at least one commit), or add the `--id` flag to explicitly specify the environment ID.


:::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).
Expand Down

0 comments on commit cd541ec

Please sign in to comment.