Postmaiden is an application for testing and documenting HTTP APIs, with straightforward usability, made for developers.
Having Node 20 installed and in use:
npm install
Then the development instance:
npm run dev
Now open the application in your browser following the output URL.
And that's it. There's really no server, by default nobody is intercepting your requests here.
For core development, there are some useful testing scripts:
npm t
to run all tests, including a full report of coverage and test names.npm run test:watch -- src/example/thing.test.tsx
to run only a specific test file, and keep running again after each file change.npm run test:debug -- src/example/thing.test.tsx
to run only a specific test file, but displaying moreconsole.log
stuff and almost unlimited RTLscreen.debug()
.
- Offline-first for free plan features, powered by OPFS.
- Mainly desktop interface, widths greater than 900px.
- Chrome and Firefox support.
- Tech stack is React 18 with TypeScript and Testing Library, bundled with Vite.
- Components bootstrapped by Shadcn UI.
- CSS tool is Tailwind.
- Icons by Font Awesome, but specifically free and React individual imports.
- Serverless cloud infrastructure.
- Reasonable test coverage on each feature.
For each "big feature", I'll write something about it in Portuguese (BR):
- Introduction to OPFS: https://mazuhsoftwares.com/2024/03/04/manipulando-arquivos-no-frontend-com-origin-private-file-system-opfs-nativamente/
Released under MIT License by "Mazuh Softwares", maintained by Marcell G. C. da Silva.