chore: rename .env.example to .env.local.example, discourage use of yarn v1 in the docs

This commit is contained in:
Alessio Gravili 2024-06-03 23:00:11 -04:00
parent 6e8236eb38
commit e6811ae0df
No known key found for this signature in database
GPG Key ID: 4343AC3FB47BC3B4
2 changed files with 3 additions and 3 deletions

View File

@ -52,10 +52,10 @@ To try out this repo yourself, follow the steps below:
1. Clone the repo to your computer (`git clone git@github.com:payloadcms/payload-3.0-demo.git`)
2. `cd` into the new folder by running `cd ./payload-3.0-demo`
3. Copy the `.env.example` by running `cp .env.example .env` in the repo, then fill out the values including the connection string to your DB
4. Install dependencies with whatever package manager you use (`yarn`, `npm install`, `pnpm i`, etc.)
3. Copy the `.env.local.example` by running `cp .env.local.example .env.example` in the repo, then fill out the values including the connection string to your DB
4. Install dependencies with whatever package manager you use (`pnpm o`, `npm install`, `yarn`, etc.). `pnpm` is highly recommended. The usage of yarn v1 is discouraged.
5. Start your database. For local postgresql use `.\start-database.sh` to start it in docker container.
6. Fire it up (`yarn dev`, `npm run dev`, `pnpm dev`, etc.)
6. Fire it up (`pnpm dev`, `npm run dev`, `yarn dev`, etc.)
7. Visit https://localhost:3000 and log in with the user created within the config's `onInit` method
### Follow along with breaking changes