diff --git a/.github/workflows/ci-cd.yml b/.github/workflows/ci-cd.yml index c8fa0b7..bcee0ad 100644 --- a/.github/workflows/ci-cd.yml +++ b/.github/workflows/ci-cd.yml @@ -19,17 +19,17 @@ jobs: strategy: fail-fast: false matrix: - os: [ubuntu-20.04] - node: [16] + os: [ubuntu-latest] + node: [18] steps: - name: Checkout - uses: actions/checkout@v3 + uses: actions/checkout@v4 with: persist-credentials: false - name: Use Node.js ${{ matrix.node }} - uses: actions/setup-node@v3 + uses: actions/setup-node@v4 with: node-version: ${{ matrix.node }} registry-url: 'https://registry.npmjs.org' @@ -57,16 +57,16 @@ jobs: strategy: matrix: - node: [16] + node: [18] steps: - name: Checkout - uses: actions/checkout@v3 + uses: actions/checkout@v4 with: persist-credentials: false - name: Use Node.js ${{ matrix.node }} - uses: actions/setup-node@v3 + uses: actions/setup-node@v4 with: node-version: ${{ matrix.node }} registry-url: 'https://registry.npmjs.org' @@ -80,7 +80,7 @@ jobs: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - name: Publish - uses: nick-invision/retry@v2 + uses: nick-invision/retry@v3 with: timeout_minutes: 5 retry_wait_seconds: 60 diff --git a/.github/workflows/license-check-workflow.yml b/.github/workflows/license-check-workflow.yml index da95658..b79f9f6 100644 --- a/.github/workflows/license-check-workflow.yml +++ b/.github/workflows/license-check-workflow.yml @@ -28,12 +28,12 @@ jobs: steps: - name: Checkout - uses: actions/checkout@v3 + uses: actions/checkout@v4 with: fetch-depth: 2 - name: Use Node.js ${{ matrix.node }} - uses: actions/setup-node@v3 + uses: actions/setup-node@v4 with: node-version: ${{ matrix.node }} diff --git a/README.md b/README.md index 9c0abb0..b1e8948 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,28 @@ A time graph / gantt chart library for large data (e.g. traces) +## Prerequisites + +First, you need Node.js and yarn: + +It's suggested to install [nvm](https://github.com/nvm-sh/nvm#installing-and-updating) to manage node on your machine. Once that's done, install the required version: + +```bash + nvm install 18 + # optional: make it the default version + nvm alias default + # or set it every time like so + nvm use 18 +``` + +Then install `yarn`: + +```bash +npm i -g yarn # the default version should be ok +``` + +# Build + To build, from the root type `yarn` To test an application type `yarn start` then open localhost:8080 on your web browser