Poirot

About The Project

Open-sourced tool for inspecting verifiable credentials.

Will be aligned with eIDAS 2.0

(back to top)

Built With

This project is a next.js project.

Using other technologies like:

• Tailwindcss
• Chadcn/ui
• Cypress
• Vitest
• Lucide
• Storybook
• Typedoc

(back to top)

Getting Started

Note: Remember to follow theses in steps.

1 - Install Prerequisites

This project uses pnpm as a package manager. Others may work, but issues with other package managers will not be fixed.

• npm

  npm install npm@latest -g

• pnpm

  npm install pnpm@9.0.6 -g

2 - Installation

1. Clone the repo

   git clone git@github.com:kantega/vc-inspector.git

2. cd into folder

   cd vc-inspector

3. Install packages

   pnpm install

3 - Start development environment

pnpm dev

Open http://localhost:3000 with your browser.

Other

Other possibilties, remember to complete the two first installation above before running any of these.

Storybook

Storybook shows compoents in isolations, to start storybook run:

pnpm storybook

Open http://localhost:6006 with your browser.

Documentation

Documentaion is hosted here, but can be generated locally to, run

pnpm typedoc

to generate the documentation (Note: a lot of warnings are generated but this is fine.)

Than you can open the ./out/inspector-docs/index.html with a browser or serve it with:

pnpx http-server out/inspector-docs/

Pre-commits (recommended)

Pre-commits runs before a commit and runs linting and formating. Before first commit, run:

pnpm husky

to initialize husky pre-commits.

(back to top)

Roadmap

• [ ] Support for SD-JWT
• [ ] Assure alignment with eIDAS 2.0

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue. Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b <issue-number>/feature-name)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin <issue-number>/feature-name)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Acknowledgments and Origins

The first version of this tool was developed as part of a master's thesis in collaboration between NTNU and Kantega. Complete thesis Special thanks to Thomas H. Svendal and Carl J. Gutzkow for their contributions.

• Lucide

(back to top)