From 87f803ca3ea3c47a6cdd1281cdbbe1d44128b45f Mon Sep 17 00:00:00 2001 From: Ojakoo Date: Wed, 21 Dec 2022 16:41:50 +0200 Subject: [PATCH] Update readme. --- README.md | 21 ++++++++++++++++----- 1 file changed, 16 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 8d175d2..c14c60b 100644 --- a/README.md +++ b/README.md @@ -5,14 +5,25 @@ This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next * **[React](https://facebook.github.io/react/)** (17.x) * **[Typescript](https://www.typescriptlang.org/)** (4.x) * **[Next.js](https://nextjs.org/)** (12.x) -* [Testcafe](https://devexpress.github.io/testcafe/) - E2E Testing framework +* **[Testcafe](https://devexpress.github.io/testcafe/)** - E2E Testing framework ## Installation -1. Clone/download repo -2. Install node v16 ([`nvm`](https://github.com/nvm-sh/nvm)) -3. `cp .env.local.example .env.local` -4. `npm install` + +Install node v16 with **[Node Version Manager](https://github.com/nvm-sh/nvm#installing-and-updating)**. + +Set up your SSH key authentication in GitLab Profile Settings. Then clone the repository and checkout the master branch: +```bash +git clone git@gitlab.com:sahkoinsinoorikilta/vtmk/web2.0-frontend.git +cd web2.0-frontend +git checkout master +``` + +Create local env file for development and install dependencies: +```bash +cp .env.local.example .env.local +npm install +``` ## Getting Started