Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update some Readme bits and the StatusPage.html #32

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Update some Readme bits and the StatusPage.html #32

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a0227de
Update readme and fix the code example
stuartskelton Nov 14, 2020
4d728b9
Fix the status page so its complete html
stuartskelton Nov 14, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# ![](https://raw.githubusercontent.com/bamzi/jobrunner/master/views/runclock.jpg) JobRunner

JobRunner is framework for performing work asynchronously, outside of the request flow. It comes with cron to schedule and queue job functions for processing at specified time.
JobRunner is framework for performing work asynchronously, outside of the request flow. It comes with cron to schedule and queue job functions for processing at specified time.

It includes a live monitoring of current schedule and state of active jobs that can be outputed as JSON or Html template.
It includes a live monitoring of current schedule and state of active jobs that can be outputted as JSON or Html template.

## Install

Expand Down Expand Up @@ -61,15 +61,15 @@ func JobJson(c *gin.Context) {

func JobHtml(c *gin.Context) {
// Returns the template data pre-parsed
c.HTML(200, "", jobrunner.StatusPage())
c.HTML(200, "Status.html", jobrunner.StatusPage())

}

```
## WHY?
To reduce our http response latency by 200+%

JobRunner was created to help us process functions unrelated to response without any delays to the http response. GoRoutines would timeout because response has already been processed, closing the instance window all together.
JobRunner was created to help us process functions unrelated to response without any delays to the http response. GoRoutines would timeout because response has already been processed, closing the instance window all together.

Instead of creating a separate independent app, we wanted to save time and manageability of our current app by coupling-in the job processing. We did not want to have micro services. It's premature optimization.

Expand All @@ -96,7 +96,7 @@ Here are some examples of what we use JobRunner for:

## Compatibility

JobRunner is designed to be framework agnostic. So it will work with pure Go apps as well as any framework written in Go Language.
JobRunner is designed to be framework agnostic. So it will work with pure Go apps as well as any framework written in Go Language.

*Verified Supported Frameworks*

Expand Down Expand Up @@ -135,7 +135,7 @@ JobRunner is designed to be framework agnostic. So it will work with pure Go app
- [robfig cron v3](https://github.com/robfig/cron/tree/v3) - github.com/robfig/cron/v3
- [contributors](https://github.com/bamzi/jobrunner/graphs/contributors)

### Author
### Author
**Bam Azizi**
Github: [@bamzi](https://github.com/bamzi)
Twitter: [@bamazizi](https://twitter/bamazizi)
Expand Down
3 changes: 2 additions & 1 deletion views/Status.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,6 @@
th {
text-align: left;
}

</style>
</head>
<body>
Expand All @@ -58,3 +57,5 @@ <h1>JobRunner Status Report</h1>
</tr>
{{end}}
</table>
</body>
</html>