CryptAnalysis Tool (CAT)

Live version | Dev version
A stab at building a versatile, useful and scalable tool for analysing and cracking ciphertexts.

React with vite

This is a React project bootstrapped with vite. The interface is designed using mui and testing is handled via cypress.

Contributing

• Development Setup
• Commits
• Pull Requests

Development Setup

1. Fork from GitHub
2. Clone the forked project
3. checkout develop branch
4. Run npm i to install dependencies.
5. Start using npm run dev

Commits

Commit messages should follow the Conventional Commits standard.

Pull Requests

• Do not submit PRs against the main branch. Checkout a topic branch from the relevant branch (e.g. develop) and merge back against that branch
• Work in the src folder
• It's okay to have multiple small commits - GitHub will automatically squash it before merging
• Make sure the project can be built using npm run build
• If you are fixing a bug:
  • If you are resolving a special issue, add (fix #xxxx[,#xxxx]) (#xxxx is the issue id) in your Pull Request title.
  • Add appropriate test coverage