Skip to content

MazuhSoftwares/postmaiden

Repository files navigation

Postmaiden

Postmaiden is an application for testing and documenting HTTP APIs, with straightforward usability, made for developers.

Setting up locally

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 more console.log stuff and almost unlimited RTL screen.debug().

Non-functional Requirements

  • 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.

Sharing knowledge

For each "big feature", I'll write something about it in Portuguese (BR):

License

Released under MIT License by "Mazuh Softwares", maintained by Marcell G. C. da Silva.