Skip to content

Commit

Permalink
debug script, add more docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Mazuh committed Feb 25, 2024
1 parent dc57184 commit 1de9106
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 11 deletions.
35 changes: 25 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,32 +3,47 @@
Postmaiden is an application for testing and documenting HTTP APIs,
with straightforward usability, made for developers.

## Setting up
## Setting up locally

Having Node 20 installed and in use:

```
npm install
```

And then:
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](https://developer.mozilla.org/en-US/docs/Web/API/File_System_API/Origin_private_file_system)
- Desktop-first interface, but decently responsive
- Chrome and Firefox support
- Components bootstrapped by [Shadcn UI](https://ui.shadcn.com/)
- CSS tool is [Tailwind](https://tailwindcss.com/docs/)
powered by [OPFS](https://developer.mozilla.org/en-US/docs/Web/API/File_System_API/Origin_private_file_system).
- Mainly desktop interface, widths greater than 900px.
- Chrome and Firefox support.
- Tech stack is [React 18](https://react.dev/reference/react)
with TypeScript and [Testing Library](https://testing-library.com/docs/react-testing-library/cheatsheet),
bundled with [Vite](https://vitejs.dev/guide/why.html).
- Components bootstrapped by [Shadcn UI](https://ui.shadcn.com/docs).
- CSS tool is [Tailwind](https://tailwindcss.com/docs/).
- Icons by [Font Awesome](https://fontawesome.com/search?o=r&m=free),
free and individual imports
- Serverless cloud infrastructure
- Reasonable test coverage on each feature
but specifically free and React individual imports.
- Serverless cloud infrastructure.
- Reasonable test coverage on each feature.

## License

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
"lint": "eslint . --ext ts,tsx --report-unused-disable-directives --max-warnings 0",
"test": "jest --ci --coverage --verbose --silent=true",
"test:watch": "jest --silent=true --watch",
"test:verbose": "DEBUG_PRINT_LIMIT=9999999 npm run test -- --silent=false",
"test:debug": "DEBUG_PRINT_LIMIT=9999999 jest --silent=false",
"preview": "vite preview"
},
"dependencies": {
Expand Down

0 comments on commit 1de9106

Please sign in to comment.