Skip to content

Commit

Permalink
chore: update docs and pkg cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
barelyhuman committed Jun 24, 2023
1 parent 2683c10 commit d688bfd
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 35 deletions.
3 changes: 0 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@
"cookie-parser": "^1.4.6",
"cors": "^2.8.5",
"date-fns": "^2.30.0",
"defu": "^6.1.2",
"dotenv": "^16.3.1",
"express": "^4.18.2",
"express-edge": "3",
Expand All @@ -39,8 +38,6 @@
"morgan": "^1.10.0",
"ms": "^2.1.3",
"nodemailer": "^6.9.3",
"preact": "^10.15.1",
"preact-render-to-string": "^6.1.0",
"serve-static": "^1.15.0"
},
"devDependencies": {
Expand Down
30 changes: 0 additions & 30 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

31 changes: 29 additions & 2 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,10 +47,37 @@ class EmailQueueHandler {
```

- Compose (Self host services for dev / k8s)
- Fully Docker compatible
- Testing Mocks (Redis)
- Swagger Doc generation using JSDoc -
[Documentation](https://brikev.github.io/express-jsdoc-swagger-docs/#/)

```js
/**
*
* GET /api/ping
* @summary quickly check if the server is running or not
* @returns 200 - success - application/json
*/
@get('/api/ping')
ping(req: Request, res: Response) {
req.pushToQueue('test', {
type: '',
})
return res.send({
success: true,
now: new Date().toISOString(),
})
}
```

-

## Why?
Various reasons...., [this might be relevant](https://reaper.is/writing/20230516-ignoring-backend-productivity)

Various reasons....,
[this might be relevant](https://reaper.is/writing/20230516-ignoring-backend-productivity)

## License
[MIT](/LICENSE)

[MIT](/LICENSE)

0 comments on commit d688bfd

Please sign in to comment.