From 861cf52cde7bea7f17c3ade8141c214f9c1580ee Mon Sep 17 00:00:00 2001 From: MarconLP <13001502+MarconLP@users.noreply.github.com> Date: Fri, 5 May 2023 01:28:32 +0200 Subject: [PATCH] add e2e testing documentation to README.md --- README.md | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 9b78a25..b16c3ba 100644 --- a/README.md +++ b/README.md @@ -37,19 +37,19 @@ git clone https://github.com/MarconLP/snapify.git ``` -1. Go to the project folder +2. Go to the project folder ```sh cd snapify ``` -1. Install packages with yarn +3. Install packages with yarn ```sh npm i ``` -1. Set up your .env file +4. Set up your .env file - Duplicate `.env.example` to `.env` - Use `openssl rand -base64 32` to generate a key and add it under `NEXTAUTH_SECRET` in the .env file. - Fill in the other variables @@ -61,6 +61,15 @@ npm run dev ``` +### E2E-Testing + +Be sure to set the environment variable `NEXTAUTH_URL` to the correct value. If you are running locally, as the documentation within `.env.example` mentions, the value should be `http://localhost:3000`. + +```sh +# In a terminal just run: +npm run test:e2e +``` + ## Deployment ### Vercel