Skip to content

securesign/rekor-search-ui

 
 

Repository files navigation

🧪 Unit Tests (Jest) 🧪 codecov

This repo contains a simple UI for searching Search the Rekor public transparency log.

https://securesign.github.io/rekor-search-ui/

Rekor UI Screenshot

Requirements

Getting Started

First, install the dependencies:

npm install

Then, run the development server:

npm run dev

Open http://localhost:3000 with your browser to see the result.

Tests

Unit Tests

Run all Jest and React Testing Library unit tests:

npm run test

Launches the test runner in the interactive watch mode.

Tests are co-located and live as closely to corresponding code as possible.

E2E Tests

Run all Cypress e2e tests:

npm run cy:open

Or in headless mode:

npm run cy:headless

Stories

We use Storybook for Component Driven Development (CDD) where possible. Storybook makes it easy to keep presentational components isolated. You can learn more about how to create a story for your UI component here.

To run Storybook locally: npm run storybook

npm run storybook

Deploy

The app is based on Next.JS and is automatically built & deployed to GitHub Pages when pushing to the main branch.

Internal Server Configuration

This app supports overriding of the default rekor server instance for those running private instances of the Trusted Artifact Signer (TAS) stack. Create a .env.local file at the root and include in it this environment variable

NEXT_PUBLIC_REKOR_DEFAULT_DOMAIN=https://privaterekor.example.com

Languages

  • TypeScript 78.9%
  • MDX 13.6%
  • JavaScript 3.7%
  • CSS 2.5%
  • Dockerfile 1.2%
  • Shell 0.1%