https://github.com/AnderssonPeter/CompressedStaticFiles

asp.net core middleware to send compressed static files to the browser without having to compress on demand, also has support for sending more advanced image formats when the browser indicates that i has support for it.
https://github.com/AnderssonPeter/CompressedStaticFiles

asp-net-core avif brotli compression gzip precompressed staticfiles webp zopfli zopflipng zstandard zstd

Last synced: 3 months ago
JSON representation

asp.net core middleware to send compressed static files to the browser without having to compress on demand, also has support for sending more advanced image formats when the browser indicates that i has support for it.

• Host: GitHub
• URL: https://github.com/AnderssonPeter/CompressedStaticFiles
• Owner: AnderssonPeter
• License: apache-2.0
• Created: 2016-07-15T18:20:28.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2024-03-23T19:30:30.000Z (11 months ago)
• Last Synced: 2024-05-06T08:35:42.232Z (9 months ago)
• Topics: asp-net-core, avif, brotli, compression, gzip, precompressed, staticfiles, webp, zopfli, zopflipng, zstandard, zstd
• Language: C#
• Homepage:
• Size: 2.99 MB
• Stars: 84
• Watchers: 9
• Forks: 17
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

• awesome-dotnet - CompressedStaticFiles - asp.net core middleware to send compressed static files to the browser without having to compress on demand, also has support for sending more advanced image formats when the browser indicates that i has support for it. (Libraries, Frameworks and Tools / Compression)

README

        


  

    

  

  
CompressedStaticFiles


  


    Send compressed static files to the browser without having to compress on demand, also has support for sending more advanced image formats when the browser has support for it.

    


    


    ·

    Report Bug

    ·

    Request Feature

    ·

  





[![NuGet version](https://badge.fury.io/nu/CompressedStaticFiles.svg)](https://www.nuget.org/packages/CompressedStaticFiles)

[![Nuget](https://img.shields.io/nuget/dt/CompressedStaticFiles)](https://www.nuget.org/packages/CompressedStaticFiles)

[![run unit tests](https://github.com/AnderssonPeter/CompressedStaticFiles/workflows/run%20unit%20tests/badge.svg)](https://github.com/AnderssonPeter/CompressedStaticFiles/actions?query=workflow%3A%22run+unit+tests%22)

[![Coverage Status](https://coveralls.io/repos/github/AnderssonPeter/CompressedStaticFiles/badge.svg)](https://coveralls.io/github/AnderssonPeter/CompressedStaticFiles)

[![GitHub license](https://img.shields.io/badge/license-Apache%202-blue.svg)](https://raw.githubusercontent.com/AnderssonPeter/CompressedStaticFiles/master/LICENSE)

## Table of Contents

* [About the Project](#about-the-project)

* [Getting Started](#getting-started)

* [Example](#example)

* [Acknowledgements](#acknowledgements)

## About The Project

This project allows you to serve precompressed files to the browser without having to compress on demand, this is achieved by compressing/encoding your content at build time.

## Getting Started

### Precompress content

Static nonimage files have to be precompressed using [Zopfli](https://en.wikipedia.org/wiki/Zopfli), [Brotli](https://en.wikipedia.org/wiki/Brotli) and/or [ZStandard](https://en.wikipedia.org/wiki/Zstd), see the example for how to do it with gulp.

The files must have the exact same filename as the source + `.br` or `.gzip` (`index.html` would be `index.html.br` for the Brotli version and `index.html.zst` for Zstandard).

### Encode images

Modern browsers support new image formats like webp and avif they can store more pixels per byte.

You can convert your images using the following tools [webp](https://developers.google.com/speed/webp/download) and [libavif](https://github.com/AOMediaCodec/libavif).

The files must have the same filename as the source but with a new file extension (`image.jpg` would be `image.webp` for the webp version).

### ASP.NET

Add `AddCompressedStaticFiles()` in your `Startup.ConfigureServices()` method.

Replace `UseStaticFiles();` with `UseCompressedStaticFiles();` in `Startup.Configure()`.

By default CompressedStaticFiles is configured to allow slightly larger files for some image formats as they can store more pixels per byte, this can be disabled by calling `CompressedStaticFileOptions.RemoveImageSubstitutionCostRatio()`.

## Example

A example can be found in the [Example](https://github.com/AnderssonPeter/CompressedStaticFiles/tree/master/Example) directory.

By using this package the Lighthouse mobile performance went from `76` to `98` and the transferred size went from `526 kb` to `141 kb`.

## Acknowledgements

This solution is based on @neyromant from the following issue https://github.com/aspnet/Home/issues/1584#issuecomment-227455026.