README.md

Grunt version of Project Zeppelin / GDG DevFest 2014 site template

About

Project Zeppelin allows you to setup awesome GDG DevFest site in 5 minutes.

Grunt version of this project allows you to get easier more optimized site. Several commands will simplify development process. Furthermore, now project supports i18n.

You can find original project here.

Template is brought by GDG Lviv team.

Live demo http://gdg-x.github.io/zeppelin-grunt/

Features

• Easy to setup
• Simple and responsive design
• Integrated speakers and sessions management
• i18n
• SVG icons
• SEO friendly
• Optimized

Quick-start guide

1. Fork this repo
2. Clone locally
3. Install Node.js and Ruby
4. Run gem install bundler
5. Install 'grunt-cli' and 'bower' globally with npm install -g grunt-cli bower
6. $cd to the directory and run bundle install
7. Run npm install to install the necessary "npm" dependencies
8. Then run bower install to install the front-end dependencies
9. Edit site variables

In Gruntfile.js edit baseurl and git_repo (destination repository):

grunt.initConfig({
        app: {
            source: 'app',
            dist: 'dist',
            baseurl: 'zeppelin-grunt',  // Here
            git_repo: '[email protected]:gdg-x/zeppelin-grunt.git'  // And here
        },
    ...

In _config.yml you should also update baseurl and url:

# Site settings
baseurl: "/zeppelin-grunt"  // Here
url: "http://gdg-x.github.io"  // And here
permalink: '/blog/:title'
...

Now you are ready for development. Following commands are available:

1. grunt (by default it runs grunt serve) - build and start your site for development (with livereload, js uglifing and sass compilation)
2. grunt serve:dist - build and start your site with production configs (this is how it will look online)
3. grunt deploy - build and deploy your site into a repository you defined in previous steps

More documentation you can find here.

Who is using template?

Going to use template? Go on! The only thing we ask - let us know at [email protected] so we can include you to this list, or make a pull request.

View known sites that use the original project.

Android Developer Days 2015	droidcon Vienna 2016

Used libraries

• Bootstrap Sass
• Animate.css Sass
• Waves
• jquery.appear
• jQuery countTo Plugin
• Typed.js
• Sticky-kit

Contributors

Created by Oleh Zasadnyy, GDG Lviv.

See list of contributors.

Maintainer: @ozasadnyy.

GDG Apps, GDG[x] are not endorsed and/or supported by Google, the corporation.

License

Project is published under the MIT license. Feel free to clone and modify repo as you want, but don't forget to add reference to authors :)