Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/utensils/barcoded
A barcode generation web service.
https://github.com/utensils/barcoded
barcode docker multiple-symbologies symbologies upc webservice
Last synced: 2 months ago
JSON representation
A barcode generation web service.
- Host: GitHub
- URL: https://github.com/utensils/barcoded
- Owner: utensils
- License: mit
- Created: 2014-04-27T18:26:21.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2018-03-19T23:15:17.000Z (over 6 years ago)
- Last Synced: 2024-07-15T16:55:55.388Z (4 months ago)
- Topics: barcode, docker, multiple-symbologies, symbologies, upc, webservice
- Language: Ruby
- Homepage: utensils.io/barcoded
- Size: 135 KB
- Stars: 49
- Watchers: 11
- Forks: 5
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Barcoded
Barcoded intends to provide a simple API for the generation of barcodes in multiple symbologies.
[](https://travis-ci.org/UtensilsUnion/barcoded) [](https://codeclimate.com/github/UtensilsUnion/barcoded) [](https://coveralls.io/r/UtensilsUnion/barcoded) [](https://gemnasium.com/UtensilsUnion/barcoded)
## Getting Started
Because we know how awesome you are, we've provided you options for running Barcoded:
### Without Docker
1. Install the required software dependencies if you have not already:
+ Ruby 2.0+
+ ImageMagick 6.8+
2. At the command prompt, clone the project:
`git clone [email protected]/UtensilsUnion/barcoded`
3. Change directory to `barcoded` and install our gems:
`bundle install`
4. At last we are ready to get this show on the road:
`bundle exec rackup`
### With Docker
1. Install required dependencies on your host:
+ [Docker](http://docker.io) 0.9+
2. Run the following command from your host's terminal:
```shell
docker run -p 0.0.0.0:8080:8080 utensilsunion/barcoded
```
3. Access the service at: `http://yourhost:9000/`
4. Barcode!
__Configuration__
The following options are available for use with the container:
+ RACK_ENV _(default: production)_
+ RACK_CORS _(default: disabled)_
+ UNICORN_WORKERS _(default: 1)_
+ UNICORN_TIMEOUT _(default: 30)_
To run the application with 4 Unicorn workers:
```shell
docker run -P -e UNICORN_WORKERS=4 utensilsunion/barcoded
```
## Symbologies
+ [Bookland](http://en.wikipedia.org/wiki/Bookland)
+ [Code 128](http://en.wikipedia.org/wiki/Code_128)
+ [Code 25 Interleaved 2 of 5](http://en.wikipedia.org/wiki/Interleaved_2_of_5)
+ [Code 25 Non-interleaved 2 of 5](http://en.wikipedia.org/wiki/Interleaved_2_of_5)
+ [Code 39](http://en.wikipedia.org/wiki/Code_39)
+ [Code 93](http://en.wikipedia.org/wiki/Code_93)
+ [EAN-13](http://en.wikipedia.org/wiki/EAN-13)
+ [EAN-8](http://en.wikipedia.org/wiki/EAN-8)
+ [IATA](http://en.wikipedia.org/wiki/International_Air_Transport_Association)
+ [QR Code](http://en.wikipedia.org/wiki/QR_code)
+ [UPC-A](http://en.wikipedia.org/wiki/Universal_Product_Code)
+ [UPC/EAN Supplemental 2](http://en.wikipedia.org/wiki/EAN_2)
+ [UPC/EAN Supplemental 5](http://en.wikipedia.org/wiki/EAN_5)
## Formats
+ PNG
+ GIF
+ JPG
+ SVG
## Examples
Download a code128 barcode as a jpeg with the value of **12345ABC**
```shell
curl -O http://localhost:8080/img/code128/1235ABC.jpg
```
Download a QR Code as a png with the value of **BarcodedRocks**, specifying a hight and width of **800x800**.
```shell
curl -o BarcodedRocks.png \
"http://localhost:8080/img/qr/BarcodedRocks.png?height=800&width=800"
```
## Why?
Businesses need barcodes and adding support to legacy systems for new symbologies can be non-trival, enter Barcoded. Leveraging our simple API, businesses can generate barcodes in multiple symbologies on-demand without ever making a code change.
## Demo
To see Barcoded in action check out the [project page](http://utensils.io/barcoded).
## Testing
1. As simple as:
`bundle exec rspec`
## Contributing
Feedback and features welcome! Please make use of [Issues](https://github.com/UtensilsUnion/barcoded/issues) and [Pull Requests](https://github.com/UtensilsUnion/barcoded/pulls), all code must have accompanying specs.
## Author/Contact
Barcoded is written and maintained by [@doomspork](https://github.com/doomspork).
## License
The project is made available under the [MIT](http://opensource.org/licenses/MIT) License.