2014-07-28 21:27:01 +02:00
# Project Zeppelin / GDG DevFest 2014 site template
2016-11-01 01:57:41 +01:00
### About
Project Zeppelin allows you to setup awesome GDG DevFest site in 5 minutes.
2014-07-28 21:27:01 +02:00
2015-02-20 23:35:58 +01:00
Project is built on top of [Jekyll ](http://jekyllrb.com/ ) - simple, blog-aware, static site generator. Jekyll also happens to be the engine behind GitHub Pages, which means you can use Jekyll to host your website from GitHub’ s servers for free. [Learn more about Jekyll ](http://jekyllrb.com/ ).
2014-07-28 21:27:01 +02:00
Template is brought by [GDG Lviv ](http://lviv.gdg.org.ua/ ) team.
2014-07-28 21:33:01 +02:00
### Live demo http://gdg-x.github.io/zeppelin/
2014-07-28 21:27:01 +02:00
2015-03-09 15:42:30 +01:00
#### Automated version with Grunt <https://github.com/gdg-x/zeppelin-grunt>
2014-07-28 21:27:01 +02:00
### Features
* Easy to setup
* Simple and responsive design
2014-09-26 10:28:48 +02:00
* Integrated speakers and sessions management
2014-07-28 21:27:01 +02:00
* SVG icons
* SEO friendly
### Quick-start guide
2014-07-28 21:33:01 +02:00
1. [Fork ](https://github.com/gdg-x/zeppelin/fork ) this repo
2014-07-28 21:27:01 +02:00
2. Clone locally
2016-11-01 01:57:41 +01:00
3. Update ```_config.yml```
2014-07-28 21:27:01 +02:00
4. Select what content blocks do you need
5. Push changes to ```gh-pages``` branch
2014-07-28 21:33:01 +02:00
6. Enjoy your awesome DevFest site at ```http://[your github name].github.io/zeppelin/```
2014-09-26 20:48:46 +02:00
2014-09-26 20:48:11 +02:00
Or watch project presentation from [GDG[x] Townhall meeting](http://www.youtube.com/watch?v=xYmhheoLjcI). Slides available [here ](https://docs.google.com/presentation/d/19aM7yNl_orDaCNND5LpCY3fShb6PyMltnzYfKvV8R_8/edit?usp=sharing )
2014-07-28 21:27:01 +02:00
## Local development
2015-02-20 23:35:58 +01:00
Check if you have [all requirements for local environment ](http://jekyllrb.com/docs/installation/ ).
To install all development dependencies install [Bundler ](http://bundler.io/ ).
2014-11-14 17:56:12 +01:00
```bash
2015-02-22 14:55:10 +01:00
gem install bundler
2016-11-01 01:57:41 +01:00
```
2015-02-20 23:35:58 +01:00
and run next command from root folder:
```bash
2015-02-22 14:55:10 +01:00
bundle install
2015-02-20 23:35:58 +01:00
```
2014-07-28 21:27:01 +02:00
2015-02-20 23:38:01 +01:00
To start Jekyll run:
2014-07-28 21:27:01 +02:00
```bash
jekyll serve -w
```
2014-11-14 17:56:12 +01:00
Site will be available at http://127.0.0.1:4000/zeppelin/ or http://localhost:4000/zeppelin/ (on Windows)
2014-07-28 21:27:01 +02:00
**NOTE:** in this mode all changes to html and data files will be automatically regenerated, but after changing ```_config.yml``` you have to restart server.
2014-11-14 17:56:12 +01:00
### Sass(Compass) support
2015-02-20 23:35:58 +01:00
**Note:** You need to install [Node.js ](http://nodejs.org/download/ )
2014-11-14 17:56:12 +01:00
To watch changes of `.sass` files and compile it to the `.css` on a fly change property `safe: true` to `safe: false` in `_config.yml` .
**Note: It works only on local machine, because GitHub runs Jekyll in `--save` [mode ](https://help.github.com/articles/using-jekyll-with-pages/#configuration-overrides )**
2014-08-08 14:51:08 +02:00
Learn more about Sass development from [documentation ](https://github.com/gdg-x/zeppelin/wiki/Sass-development ).
2014-07-28 21:27:01 +02:00
### Resource optimizations (optional)
2015-02-20 23:35:58 +01:00
You can optimize images and minify css and javascript automatically (for now only on Windows).
2014-10-10 00:51:03 +02:00
But for Mac OS users available amazing tool - [imageoptim ](https://imageoptim.com/ ). Thanks [@raphaelsavina ](https://github.com/raphaelsavina ) for link.
2014-07-28 21:27:01 +02:00
Optimize all images by running this script from `/automation/images/` folder:
```bash
all_image_optimization.bat -d -jtran -pout -pquant -optip -gsicle -svgo
```
2015-02-18 16:38:06 +01:00
To minify CSS and JS run `minify_js.bat` (for Windows) and `minify_js.sh` (for Linux and MacOS) from `/automation/minifying/` folder:
2014-07-28 21:27:01 +02:00
```bash
2015-02-18 16:38:06 +01:00
minify_js.bat
2014-07-28 21:27:01 +02:00
```
2014-07-28 21:33:01 +02:00
Learn more about available optimization options from [documentation ](https://github.com/gdg-x/zeppelin/wiki/Resources-optimizations ).
2014-07-28 21:27:01 +02:00
### Documentation
2014-07-28 21:33:01 +02:00
Quick-start guide is not enough? Checkout [full documentation ](https://github.com/gdg-x/zeppelin/wiki ).
2014-07-28 21:27:01 +02:00
### Used libraries
* [Bootstrap ](https://github.com/twbs/bootstrap )
* [Animate.css ](https://github.com/daneden/animate.css )
* [Waves ](https://github.com/publicis-indonesia/Waves )
* [jquery.appear ](https://github.com/bas2k/jquery.appear )
* [jQuery countTo Plugin ](https://github.com/mhuggins/jquery-countTo )
* [Typed.js ](https://github.com/mattboldt/typed.js )
2014-08-14 23:27:17 +02:00
* [Sticky-kit ](https://github.com/leafo/sticky-kit )
2014-07-28 21:27:01 +02:00
### Who is using template?
Going to use template? Go on! The only thing we ask - let us know at [*lviv@gdg.org.ua* ](mailto:lviv@gdg.org.ua ) so we can include you to this list, or make a pull request.
2014-11-25 19:02:52 +01:00
| | | |
|------|------|------|
2015-11-18 19:19:03 +01:00
| [GDG DevFest Ukraine 2014 ](http://devfest.gdg.org.ua/ ) | [GDG DevFest Istanbul 2014 ](http://2014.devfesttr.com/ ) | [GDG Bangalore Site ](http://gdgbangalore.github.io/ ) |
2014-11-25 19:02:52 +01:00
| [GDG DevFest Omsk 2014 ](http://gdg-devfest-omsk.org/ ) | [2014 南阳 GDG Devfest 大会 ](http://devfest.gdgny.org ) | [DevFest Nordeste 2014 ](http://2014.devfestne.com.br/ ) |
| [GDG DevFest The Netherlands ](http://www.devfest.nl/ ) | [DevFest Centro-Oeste 2014 ](http://www.devfestcentrooeste.com.br/ ) | [Android DevFest Space Coast ](http://gdg-space-coast.github.io/zeppelin/ ) |
2014-11-26 13:56:25 +01:00
| [DevFest SP 2014 ](http://sp.devfest.com.br/ ) | [DevFest in Baroda ](http://devfest.gdgbaroda.com/ ) | [GDG Hi Pic (France) ](http://maximemularz.github.io/zeppelin/ ) |
2014-11-25 19:02:52 +01:00
| [GDG DevFest Córdoba 2014 ](http://gdgcordoba.github.io/zeppelin/ ) | [GDG DevFest Düsseldorf 2014 ](http://www.gdg-dus.de/DevFest2014/ ) | [GDG Makerere DevFest 2014 ](http://gdgmakerere.github.io/ ) |
| [GDG Dublin DevFest 2014 ](http://gdg-dublin.appspot.com/ ) | [GDG Busitema DevFest 2014 ](http://gdgbusitema.github.io/ ) | [DevFest Vienna 2014 ](http://www.devfest.at/ ) |
| [Android Wear DevFest ](http://devfest.gdgnorthjersey.com/wear2014/ ) | [GDG SLAU DevFest 2014 ](http://gdgslau.github.io/ ) | [Lima DevFest ](http://limadevfest.com/ ) |
| [GDG Korea DevFair 2014 ](http://devfair2014.gdg.kr/ ) | [GDG DevFest Kota Kinabalu 2014 ](http://devfest.gdgkk.info/ ) | [GDG DevFest Belgium ](http://gdg-brussels.org/DevFest2014/ ) |
2014-11-25 19:05:02 +01:00
| [DevFest Praha 2014 ](http://devfest.cz/ ) | [GDG DevFest Kosice ](http://devfest.sk/ ) | [GDG DevFest Cagayan de Oro ](http://devfest.gdgcdo.org/ ) |
2014-11-26 14:25:46 +01:00
| [DevFest Birgunj ](http://gdgbirgunj.github.io/DevFest2014/ ) | [GDG DevFest Poland ](http://devfest.pl/ ) | [GDG DevFest Silicon Valley ](http://devfest2014.gdgsv.com/ ) |
2014-11-27 13:21:47 +01:00
| [DevFest Chennai 2014 ](http://devfest.gdgchennai.com/ ) | [GDG DevFest Bari ](http://gdgbari.github.io/zeppelin/ ) | [GDG DevFest Ahmedabad ](http://devfest.gdgahmedabad.com/ ) |
2016-11-01 01:57:41 +01:00
| [GDG DevFest Sri Lanka ](http://www.devfestlk.org/ ) | [GDG DevFest Tunis ](http://devfest.gdgtunis.org/ ) | [GDG DevFest Kozhikode ](http://devfest.gdgkozhikode.org/ ) |
| [GDG DevFest Argentina ](http://devfest.gdg.com.ar/ ) | [GDG DevFest Bhubaneswar ](http://devfest2014.gdgbbsr.com/ ) | [GDG DevFest Miage Gi ](http://gdgmiagegilab.github.io/ ) |
2014-12-20 17:44:48 +01:00
| [GDG DevFest NORTE ](http://norte.devfest.com.br/ ) | [GDG Devfest Nyeri 2014 ](http://devfest.gdgkimathiuniversity.com/ ) | [GDG DevFest Paris ](http://devfest.gdgparis.com/ ) |
2017-01-13 23:33:19 +01:00
| [GDG Akure ](http://gdgakure.github.io/ )|[MENAT GDG Summit 2014](http://summit.gdg-menat.com/)|[Women Techmakers Istanbul 2015](http://2015.wtmistanbul.com) |
2015-03-04 15:11:03 +01:00
| [GDG DevFest Mallorca ](http://devfest.gdgmallorca.com/ )| [Michigan GDG DevFest 2015 ](http://michigandevfest.com/ ) | [International Women's Day ](http://iwd.gdgnorthjersey.com/womeninnovation/ ) |
2015-05-14 18:01:22 +02:00
| [Women Techmakers Tbilisi 2015 ](http://womentechmakers.ge/ ) | [Android Xtended ](http://www.androidxtended.com/ ) |[GDG Bingham University](http://binghamuni.edu.ng/gdg)|
2015-10-13 19:31:02 +02:00
| [JSday Maceio 2015 ](http://jsday.com.br ) | [DevFest Nordeste 2015 ](http://2015.devfestne.com.br ) | [GDG DevFest Vijayawada 2015 ](http://devfest.gdg-vijayawada.org ) |
2016-10-19 10:48:55 +02:00
| [Geek Night Recife ](http://geeknightrecife.github.io/ ) | [IO Extended 2016 Madrid ](http://io.gdg.es/ ) | [AngularCamp ](http://angularcamp.org/ ) |
2017-01-13 23:33:19 +01:00
| [Mobile Era 2016 ](http://mobileera.rocks/ ) | [GDG Francisco Beltrão ](http://gdg-fb.github.io ) | [Women Techmakers Istanbul 2016 ](http://2016.wtmistanbul.com ) |
2017-03-09 11:58:30 +01:00
| [Droidcon Paris 2015 ](http://droidcon.fr ) | [Android Makers Paris 2017 ](http://androidmakers.fr ) | [Heidelberger Symposium 2017 ](https://heidelberger-symposium.de/ ) |
2017-07-31 12:50:58 +02:00
| [DevFest Foumban website ](http://devfestfoumban.org ) |
2014-11-25 19:02:52 +01:00
2014-07-28 21:27:01 +02:00
### Contributors
2014-10-09 10:49:23 +02:00
* Design and web development: [Oleh Zasadnyy ](https://github.com/ozasadnyy )
* Idea: [Vitaliy Zasadnyy ](https://github.com/zasadnyy )
2016-02-11 21:44:15 +01:00
See [list of contributors ](https://github.com/gdg-x/zepplin/graphs/contributors )
2016-02-11 21:48:36 +01:00
Maintainers: [@tasomaniac ](https://github.com/tasomaniac ) and [@ozasadnyy ](https://github.com/ozasadnyy ).
2014-07-28 21:27:01 +02:00
2015-02-20 23:35:58 +01:00
### License
Project is published under the [MIT license ](https://github.com/gdg-x/zeppelin/blob/master/LICENSE.txt ). Feel free to clone and modify repo as you want, but don't forget to add reference to authors :)