Skip to content

Latest commit

 

History

History
79 lines (57 loc) · 2.58 KB

install.adoc

File metadata and controls

79 lines (57 loc) · 2.58 KB

Install instructions

Configure Git

Start by installing Git and configuring your global Git name and email address. You can do so by executing the following commands. Please make sure to use exactly the same name and email address as in your Github profile.

$ git config --global user.name "John Doe"
$ git config --global user.email [email protected]

To be safe, backup all of your existing repositories, or simply create a new folder which will contain your Github repositories. Once done, clone the Github repositories by executing the following command.

$ git clone [email protected]:netwerk-digitaal-erfgoed/solid-crs.git

In order to pull and publish packages from GitHub, you need to authenticate by using a personal access token. Start by generating one which has at least the write:packages and read:packages scopes on this page. Note that you will not be able to recover or view the token after it has been created, so keep it somewhere safe.

$ npm login --registry=https://npm.pkg.github.com
Username: [your GitHub username]
Password: [your personal access token]
Email: [your GitHub e-mail address]

Run locally

When running the app locally for the first time, or after an update, start by installing its dependencies. You can do so by executing the following command in the root of the cloned repository.

$ npm run bootstrap

Once the dependencies are installed, you can build the app by executing the following command.

$ npm run build:all

After installing and building once, you can start the app at any time by executing the following command.

$ npm run start:watch

Run with Docker

You can run the application by using docker. To use the latest published version, run the following command.

$ docker run -p 3002:3002 ghcr.io/netwerk-digitaal-erfgoed/solid-crs-manage:latest

Alternatively, you can build and run an image locally.

# Build on Linux/Mac
$ docker build --build-arg NPM_TOKEN=$NPM_TOKEN -t crs:local ./packages/solid-crs-manage/

# Build on Windows
$ docker build --build-arg NPM_TOKEN=%NPM_TOKEN% -t crs:local ./packages/solid-crs-manage/

# Run local image
$ docker run -p 3002:3002 crs:local