From 4092ecc97c665d3ba53128cde5f8ec0e32ce66d8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sof=C3=ADa=20Aritz?= Date: Sat, 29 Jun 2024 20:21:41 +0200 Subject: [PATCH] local testing instructions --- README.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/README.md b/README.md index 4c2bea4..a07955a 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,33 @@ for conditions such as dementia. Over time, the idea evolved and is now a genera The Identity project is composed by a web-app and two servers. In the future, Docker containers may be built to ease the installation of this project. +### Development and local testing + +#### `identity-web` + +1. Copy the `env.example` file: `cp .env.example .env` +2. Run `yarn` to install the dependencies. + * You may need to [enable Corepack](https://nodejs.org/api/corepack.html). +3. Run `yarn dev` and open the specified URL. +4. You're ready to go! Any changes should be reflected in real time. + +### `identity-api` + +1. Copy the `env.example` file: `cp .env.example .env` +2. Run `yarn` to install the dependencies. + * You may need to [enable Corepack](https://nodejs.org/api/corepack.html). +3. Run `yarn start` to start the server. +4. You're ready to go! You will need to restart the server manually when you make changed (unless you use something like [Nodemon](https://www.npmjs.com/package/nodemon)). + +### `asset-api` + +1. Copy the `.env.example` file: `cp .env.example .env` +2. Run `yarn` to install the dependencies. + * You may need to [enable Corepack](https://nodejs.org/api/corepack.html). +3. Run `yarn start` to start the server. + * You may need to create an empty folder at `$/asset-api/.keys`. +4. You're ready to go! You will need to restart the server manually when you make changed (unless you use something like [Nodemon](https://www.npmjs.com/package/nodemon)). + ### Building and running #### Building `identity-web`