diff --git a/docs/GETTING_STARTED.md b/docs/GETTING_STARTED.md index 0eee2b0..1edb1ab 100644 --- a/docs/GETTING_STARTED.md +++ b/docs/GETTING_STARTED.md @@ -9,19 +9,25 @@ This file covers how to get started with VERT. - [Using Docker](#using-docker) ### Prerequisites + Make sure you have the following installed: - [Bun](https://bun.sh/) ### Installation + +First, clone the repository: ```sh -# Clone the repository $ git clone https://github.com/VERT-sh/VERT $ cd VERT/ +``` -# Install dependencies +Install dependencies: +```sh $ bun i ``` +And finally, make sure you create a `.env` file in the root of the project. We've included a [`.env.example`](../.env.example) file which you can use to get started. + ### Running Locally To run the project locally, run `bun dev`. @@ -30,15 +36,6 @@ This will start a development server. Open your browser and navigate to `http:// ### Building for Production -Before building for production, make sure you create a `.env` file in the root of the project with the following content: - -```sh -PUB_HOSTNAME=example.com # change to your domain, only gets used for Plausible (for now) -PUB_PLAUSIBLE_URL=https://plausible.example.com # can be empty if not using Plausible -PUB_ENV=production # "production", "development" or "nightly" -PUB_VERTD_URL=https://vertd.vert.sh # default vertd instance -``` - To build the project for production, run `bun run build`. This will build the site to the `build` folder. You should then use a web server like [nginx](https://nginx.org) to serve the files inside that folder.