This repository is a web application currently used for testing and demonstration of the Document Analyzer project and Document Validation API (internal). The application allows users to upload documents and get feedback from the API on how well their document adheres to formatting and form-validation expectations.
Public contributions are welcome! Please see our contribution guidelines for details on how best to contribute code.
We welcome bugs and responsible disclosures. Please see our security guidelines for details.
This is a TypeScript- and Next.js-based full-stack web application. It uses Tailwind for CSS styling. Additional dependencies can be found in the package.json file.
Download the repository and run npm i to install dependencies.
Run npm run dev to build and run the application in development mode.
Run npm run test to run unit tests with Vitest. When running this process, Vitest uses a 'watch' process that automatically reruns relevant tests when a file is saved.
Coding agents and LLMs should read the development principles in the AGENTS.md file for coding guidelines for this project.
This repository uses husky to run git hook scripts. Currently this runs formatting using the lint-staged tool on the pre-commit hook, which runs Biome to performing linting and formatting checks.
This project runs the following processes via Github Actions:
- File formatting and linting via Biome
- Unit Tests via Vitest
- End-to-End Tests via Playwright
- Dependency updates are handling via Renovate