Skip to content

acdamiani/cryptools

Repository files navigation

Cryptography reference website built using Next.js

PRs welcome! License Language

Getting Started

Clone the repository by running the following command:

git clone git@github.com:acdamiani/cryptools.git

Then, install its dependencies using pnpm.

pnpm install

And run!

# Dev server
pnpm dev

# Build server
pnpm build && pnpm start

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

Requirements

  • Node.js >= 12.22.0
  • pnpm 7

Directory Structure

  • .github — GitHub configuration including the CI workflow.
  • .husky — Husky configuration and hooks.
  • components — React component library, including buttons, toggles, etc.
  • hooks — Custom react hooks.
  • layouts — Next.js page layouts and styles.
  • pages — Next.js tsx page components.
  • public — Static assets including images and SVGs.
  • src — App logic and operations, including converters, hashes, encoders, etc.
  • styles — Styles for specific pages.
  • testMocha test directory. (WIP)

License

This project is licensed under the MIT License - see the LICENSE.md file for more information.