Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/zenorocha/browser-diet

:fries: The definitive front-end performance guide
https://github.com/zenorocha/browser-diet

Last synced: about 2 months ago
JSON representation

:fries: The definitive front-end performance guide

Host: GitHub
URL: https://github.com/zenorocha/browser-diet
Owner: zenorocha
Created: 2012-01-02T18:05:59.000Z (over 12 years ago)
Default Branch: master
Last Pushed: 2021-02-01T10:56:54.000Z (over 3 years ago)
Last Synced: 2024-04-14T04:01:55.617Z (5 months ago)
Language: CSS
Homepage: https://browserdiet.com
Size: 23.3 MB
Stars: 2,210
Watchers: 150
Forks: 444
Open Issues: 5
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        # How to lose weight (in the browser) [![Build Status](https://secure.travis-ci.org/zenorocha/browser-diet.svg?branch=master)](https://travis-ci.org/zenorocha/browser-diet)

The definitive front-end performance guide.

![image](https://cloud.githubusercontent.com/assets/398893/3528424/3368fc18-078f-11e4-9226-cdda8e13e5c9.jpg)

## Contributing

If you want to add new tips or edit the existing ones, just go to the [src/documents](https://github.com/zenorocha/browser-diet/blob/master/src/documents) folder. There you can find all of them in [Markdown (.md)](https://pt.wikipedia.org/wiki/Markdown) format. Remember to add references on each tip that you write at [References](https://github.com/zenorocha/browser-diet/wiki/References) wiki.

## Instructions

#### How can I locally run the project?

1. Install [Git](http://git-scm.com/downloads) and [NodeJS](https://nodejs.org/download/), if you don't have them already.

2. Open your terminal and download [DocPad](https://github.com/docpad/docpad) through this command:

  ```sh

  $ [sudo] npm install -g [email protected]

  ```

3. Now clone it:

  ```sh

  $ git clone [email protected]:/browser-diet.git

  ```

4. Then go to the project's folder:

  ```sh

  $ cd browser-diet

  ```

5. Install all dependencies:

  ```sh

  $ npm install

  ```

6. And finally run:

  ```sh

  $ docpad run

  ```

Now you can see the website running at `localhost:9778` :D

#### How can I run another language version?

Simply go to the [docpad.coffee](https://github.com/zenorocha/browser-diet/blob/master/docpad.coffee) file and change the value of the `currentLang` variable.

Then you just need to run `docpad run` again.

## Browser Support

We do care about it.

![IE](https://cloud.githubusercontent.com/assets/398893/3528325/20373e76-078e-11e4-8e3a-1cb86cf506f0.png) | ![Chrome](https://cloud.githubusercontent.com/assets/398893/3528328/23bc7bc4-078e-11e4-8752-ba2809bf5cce.png) | ![Firefox](https://cloud.githubusercontent.com/assets/398893/3528329/26283ab0-078e-11e4-84d4-db2cf1009953.png) | ![Opera](https://cloud.githubusercontent.com/assets/398893/3528330/27ec9fa8-078e-11e4-95cb-709fd11dac16.png) | ![Safari](https://cloud.githubusercontent.com/assets/398893/3528331/29df8618-078e-11e4-8e3e-ed8ac738693f.png)

--- | --- | --- | --- | --- |

IE 9+ ✔ | Latest ✔ | Latest ✔ | Latest ✔ | Latest ✔ |

## Structure

This project uses [DocPad](https://github.com/bevry/docpad), a static generator in NodeJS, and here's the basic structure:


.

|-- out/

|-- src/

|   |-- documents

|   |-- layouts

|   |-- partials

`-- package.json



#### out/

This is where the generated files are stored, once DocPad has been run. However, this directory is unnecessary for versioning, so it is ignored ([.gitignore](https://github.com/zenorocha/browser-diet/blob/master/.gitignore)).

#### [src/documents](https://github.com/zenorocha/browser-diet/blob/master/src/documents)

Contains all tips in [Markdown (.md)](http://pt.wikipedia.org/wiki/Markdown) format, in addition to images, fonts, CSS and JS files.

#### [src/layouts](https://github.com/zenorocha/browser-diet/tree/master/src/layouts)

Contains the default template.

#### [src/partials](https://github.com/zenorocha/browser-diet/tree/master/src/partials)

Contains reusable blocks of code.

#### [package.json](https://github.com/zenorocha/browser-diet/blob/master/package.json)

Lists all NodeJS dependencies.

## Team

BrowserDiet was made with love by these people and a bunch of awesome [contributors](https://github.com/zenorocha/browser-diet/graphs/contributors).

#### Creator

[![Zeno Rocha](http://gravatar.com/avatar/e190023b66e2b8aa73a842b106920c93?s=70)](https://github.com/zenorocha) |

--- |

[Zeno Rocha](https://github.com/zenorocha)
Liferay, Inc. |

#### Design

[![Briza Bueno](http://gravatar.com/avatar/c272a0a8972473fdf231f2b2d897c242?s=70)](https://github.com/brizabueno) |

--- | 

[Briza Bueno](https://github.com/brizabueno)
Americanas |

#### Authors

[![Davidson Fellipe](http://gravatar.com/avatar/054c583ad5dc09a861874e14dcb43e4c?s=70)](https://github.com/davidsonfellipe) | [![Giovanni Keppelen](http://gravatar.com/avatar/8f5c490b5b30ac6d655eced70cea4e5f?s=70)](https://github.com/keppelen) | [![Jaydson Gomes](http://gravatar.com/avatar/572696200604e59baa59ee90d61f7d02?s=70)](https://github.com/jaydson)

--- | --- | ---

[Davidson Fellipe](https://github.com/davidsonfellipe)
Globo.com | [Giovanni Keppelen](https://github.com/keppelen)
Planedia | [Jaydson Gomes](https://github.com/jaydson)
Terra

#### Reviewers

[![Marcel Duran](http://gravatar.com/avatar/87ce1e1fe50034eb0f7b6eaeb5dd9a76?s=70)](https://github.com/marcelduran) | [![Renato Mangini](http://gravatar.com/avatar/61ffaf1af13c5626d3cd975275b2ddfd?s=70)](https://github.com/mangini) | [![Sérgio Lopes](http://gravatar.com/avatar/3244c236c487924b4309fdd53cbb8633?s=70)](https://github.com/sergiolopes)

--- | --- | --- 

[Marcel Duran](https://github.com/marcelduran)
Twitter | [Renato Mangini](https://github.com/mangini)
Google | [Sérgio Lopes](https://github.com/sergiolopes)
Caelum

#### Translations

[![Mike Taylor](http://gravatar.com/avatar/8d8b46576d7de08d9e1500587c0fa8ce?s=70)](https://github.com/miketaylr) | [![Emilio Álvarez](http://gravatar.com/avatar/87488b8b39dcff7dc6f34b062dbfce37?s=70)](https://github.com/ecoal95) | [![Lukasz Jakub](http://gravatar.com/avatar/7351c99c580e5aaf32212220d66dc3ba?s=70)](https://github.com/lukasz-jakub-adamczuk) | [![Fordlee](http://gravatar.com/avatar/a0f1f645387cf64667f804e134ce89d1?s=70)](https://github.com/fordlee404) | [![Nicolas Carlo](http://gravatar.com/avatar/46978c87c5c75cea5d05a61fa8b7d95b?s=70)](https://github.com/nicoespeon) | [![Tomas Dvorak](http://gravatar.com/avatar/3d725fd7dc3cec46f01a64fd000274b4?s=70)](https://github.com/todvora) | [![Makoto Tateno](http://gravatar.com/avatar/4317f6e3c1bb7c611d4e3b6c21834ced?s=70)](https://github.com/makotot)

--- | --- | --- | --- | --- | --- | ---

[Mike Taylor](https://github.com/miketaylr)
English | [Emilio Álvarez](https://github.com/ecoal95)
Spanish | [Lukasz Jakub](https://github.com/lukasz-jakub-adamczuk)
Polish | [Fordlee](https://github.com/fordlee404)
Chinese | [Nicolas Carlo](https://github.com/nicoespeon)
French | [Tomas Dvorak](https://github.com/todvora)
Czech | [Makoto Tateno](https://github.com/makotot)
Japanese

## Credits

* DocPad by [Benjamin Lupton](https://github.com/balupton)

* Highlight.js by [Ivan Sagalaev](https://github.com/isagalaev/)

#### Fonts

* Pacifico by [Vernon Adams](http://www.fontsquirrel.com/license/pacifico)

* Open Sans by [Steve Matteson](https://www.google.com/fonts/specimen/Open+Sans)

* Horseshoes by [Lauren Ashpole](http://www.laurenashpole.com/licensing.html)

#### Illustrations

* The 56 Geeks Project by [Scott Johnson](http://www.myextralife.com/56geeks/)

* Flag Icon Set by [GoSquared](https://www.gosquared.com/resources/flag-icons/)

## License

Code is under [MIT](http://zenorocha.mit-license.org) license and content is under [Creative Commons BY-SA 3.0](http://creativecommons.org/licenses/by-sa/3.0/deed.en_US)