quirrel-dev / quirrel / 5324552306

82%

push

github

added nextjs 13 app router native support & docs improvements. (#1141)

## Summary
This PR aims to revise and add two main things:
- Bring native support for Nextjs 13 app router to Quirrel -
https://github.com/quirrel-dev/quirrel/issues/1138
- Improve the docs experience since the hosted version of Quirrel isn't
available anymore


## Nextjs 13 App Router
Because Nextjs 13 now expects a named method function as a route handler
(POST, GET etc..), we need to provide it as part of the `Queue` and
`CronJob` methods, we also want the queue instances themselves, so I've
made it so it would be accessible via object destructuring, that way we
can export both `POST` and the queue instance in one go, and alias the
queue instance with a meaningful name.

Queue Usage:
```typescript
  export const { POST, queue: sampleQueue } = Queue(
   "/api/queues/sample",
   (payload) => {
       ...logic goes here
  });
 
 await sampleQueue.enqueue({ jobData });
```

CronJob Usage:
```typescript
  export const { POST } = CronJob(
   "/api/queues/sample",
   "0 0 * * 1"
   (payload) => {
       ...logic goes here
  });
```
I've added some docs changes as well to explain the usage of the new
queue api.

**The object destructuring is the best way I could think of to keep the
named export function `POST` and still have a meaningful name for the
queue instance, if you can think of a better implementation for this
please let me know!**

## Changelog:

### code
- added new `next13.ts` file to support nextjs 13 app directory
natively.

### docs
- added to proper documentation for all of the Nextjs changes.
- added new "Development" category which explains how to run the Quirrel
instance in a docker compose, or as a standalone instance.
- added a new and improved "Deployment" category with several guides on
how to deploy quirrel (docker, railway, fly and vercel).
- removed the old "Deploy" page.

---------

Co-authored-by: S... (continued)

606 of 799 branches covered (75.84%)

Branch coverage included in aggregate %.

1148 of 1328 relevant lines covered (86.45%)

22.7 hits per line