sofia/identity
1
0
Fork 0
Code Issues 7 Pull requests Actions Packages Projects Releases Wiki Activity

local testing instructions

Browse source
This commit is contained in:
Sofía Aritz 2024-06-29 20:21:41 +02:00
parent 5cdedf8528
commit 4092ecc97c
Signed by: sofia
GPG key ID: 90B5116E3542B28F
1 changed files with 27 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
README.md
View file

@ -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`