Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aerogo/pack
:package: Packs the assets for your web server.
https://github.com/aerogo/pack
automation build-tool go
Last synced: 12 days ago
JSON representation
:package: Packs the assets for your web server.
- Host: GitHub
- URL: https://github.com/aerogo/pack
- Owner: aerogo
- License: other
- Created: 2016-11-12T15:58:25.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2019-12-04T02:19:40.000Z (about 5 years ago)
- Last Synced: 2024-10-29T21:05:51.785Z (3 months ago)
- Topics: automation, build-tool, go
- Language: Go
- Homepage:
- Size: 2.15 MB
- Stars: 20
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# pack
[![Godoc][godoc-image]][godoc-url]
[![Report][report-image]][report-url]
[![Tests][tests-image]][tests-url]
[![Coverage][coverage-image]][coverage-url]
[![Sponsor][sponsor-image]][sponsor-url]
Packs the assets for your web server.
## Installation
```shell
go get -u github.com/aerogo/pack/...
```
## Usage
Run `pack` in your project directory. It will scan your project directory recursively to compile `.pixy`, `.scarlet` and `.js` files resulting in a `components` package in your root directory. You can then import the `components` package in your project to access all of your assets.
Pack is silent by default. Use `pack -v` to produce verbose output.
### Performance
Pack uses parallel compilation via job queues and is therefore extremely fast, much faster than the popular [webpack](https://github.com/webpack/webpack).
## Components
Since `components` is a generated directory you should list this directory in your `.gitignore` file.
### CSS
```go
import "github.com/YOUR_ORG/YOUR_REPO/components/css"
```
```go
css.Bundle()
```
Returns the CSS bundle which is a string of CSS containing all styles.
### JS
```go
import "github.com/YOUR_ORG/YOUR_REPO/components/js"
```
```go
js.Bundle()
```
Returns the JS bundle which is a string of JS containing all scripts.
### Templates
```go
import "github.com/YOUR_ORG/YOUR_REPO/components"
```
Templates are registered as public functions in the `components` package and can be called directly. All components are global, thus you can call a component from one file in another file without any import directives. Components return an HTML `string` but they use a single `strings.Builder` via pooling and streaming under the hood, which is extremely fast.
## Style
Please take a look at the [style guidelines](https://github.com/akyoto/quality/blob/master/STYLE.md) if you'd like to make a pull request.
## Sponsors
| [](https://github.com/cedricfung) | [](https://github.com/soulcramer) | [](https://eduardurbach.com) |
| --- | --- | --- |
| [Cedric Fung](https://github.com/cedricfung) | [Scott Rayapoullé](https://github.com/soulcramer) | [Eduard Urbach](https://eduardurbach.com) |
Want to see [your own name here?](https://github.com/users/akyoto/sponsorship)
[godoc-image]: https://godoc.org/github.com/aerogo/pack?status.svg
[godoc-url]: https://godoc.org/github.com/aerogo/pack
[report-image]: https://goreportcard.com/badge/github.com/aerogo/pack
[report-url]: https://goreportcard.com/report/github.com/aerogo/pack
[tests-image]: https://cloud.drone.io/api/badges/aerogo/pack/status.svg
[tests-url]: https://cloud.drone.io/aerogo/pack
[coverage-image]: https://codecov.io/gh/aerogo/pack/graph/badge.svg
[coverage-url]: https://codecov.io/gh/aerogo/pack
[sponsor-image]: https://img.shields.io/badge/github-donate-green.svg
[sponsor-url]: https://github.com/users/akyoto/sponsorship