https://github.com/screwdriver-cd/queue-service
Screwdriver Queue Service API
https://github.com/screwdriver-cd/queue-service
docker redis
Last synced: 11 months ago
JSON representation
Screwdriver Queue Service API
- Host: GitHub
- URL: https://github.com/screwdriver-cd/queue-service
- Owner: screwdriver-cd
- License: other
- Created: 2020-02-12T15:54:34.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-11-01T17:51:34.000Z (over 1 year ago)
- Last Synced: 2024-11-01T18:29:00.170Z (over 1 year ago)
- Topics: docker, redis
- Language: JavaScript
- Homepage: https://cd.screwdriver.cd/pipelines/4226
- Size: 313 KB
- Stars: 0
- Watchers: 12
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Screwdriver Queue Service API
[![Version][npm-image]][npm-url] [![Pulls][docker-pulls]][docker-url] [![Stars][docker-stars]][docker-url] [![Build Status][status-image]][status-url] [![Open Issues][issues-image]][issues-url] [![Coverage][cov-image]][cov-url] [![Vulnerabilities][vul-image]][vul-url] ![License][license-image] [![Slack][slack-image]][slack-url]
## Table of Contents
- [Background](#background)
- [Installation and Usage](#installation-and-usage)
- [Configuration](#configuration)
- [Testing](#testing)
- [Contribute](#contribute)
- [License](#license)
## Background
Screwdriver Queue Service is created to decouple the build queueing mechanism from Screwdriver APIs. It is a REST service with the idea of being highly available and resilient.
## Installation and Usage
```
npm install
npm start
```
### Plugins
This API comes with 2 resources:
- [executor](plugins/executor/README.md)
- [worker](plugins/worker/README.md)
### Prerequisites
To use Screwdriver Queue Service, you will need the following prerequisites:
- Node v12.0.0 or higher
- [Redis][redis-cli]
## Contribute
To start contributing to Screwdriver, have a look at our guidelines, as well as pointers on where to start making changes, in our [contributing guide](http://docs.screwdriver.cd/about/contributing).
## License
Code licensed under the BSD 3-Clause license. See [LICENSE file](https://github.com/screwdriver-cd/screwdriver/blob/master/LICENSE) for terms.
[npm-image]: https://img.shields.io/npm/v/screwdriver-queue-service.svg
[npm-url]: https://npmjs.org/package/screwdriver-queue-service
[cov-image]: https://coveralls.io/repos/github/screwdriver-cd/queue-service/badge.svg?branch=master
[cov-url]: https://coveralls.io/github/screwdriver-cd/queue-service?branch=master
[vul-image]: https://snyk.io/test/github/screwdriver-cd/queue-service.git/badge.svg
[vul-url]: https://snyk.io/test/github/screwdriver-cd/queue-service.git
[docker-pulls]: https://img.shields.io/docker/pulls/screwdrivercd/queue-service.svg
[docker-stars]: https://img.shields.io/docker/stars/screwdrivercd/queue-service.svg
[docker-url]: https://hub.docker.com/r/screwdrivercd/queue-service/
[license-image]: https://img.shields.io/npm/l/queue-service.svg
[issues-image]: https://img.shields.io/github/issues/screwdriver-cd/queue-service.svg
[issues-url]: https://github.com/screwdriver-cd/queue-service/issues
[status-image]: https://cd.screwdriver.cd/pipelines/1/badge
[status-url]: https://cd.screwdriver.cd/pipelines/1
[slack-image]: http://slack.screwdriver.cd/badge.svg
[slack-url]: http://slack.screwdriver.cd/
[docker-compose]: https://www.docker.com/products/docker-compose
[nomad]: https://www.hashicorp.com/products/nomad
[docker]: https://www.docker.com/products/docker
[kubectl]: https://kubernetes.io/docs/user-guide/kubectl-overview/
[redis-cli]: https://redis.io/