Public website on github-pages for GDG Pisa ๐ŸŒŽ๐Ÿ‡ฎ๐Ÿ‡น๐Ÿ’ป
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commitโ€ฆ
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.github Fixed CONTRIBUTING.md anchor link Nov 3, 2017
_data Smart Home Made Easy Nov 9, 2018
_includes New infos for CFP Sep 30, 2018
_layouts New infos for CFP Sep 30, 2018
_posts Update and rename 2018-11-8-Materiale-del-talk-Smart-Home-Made-Easy.mโ€ฆ Nov 9, 2018
blog Moved about to be the Homepage Oct 19, 2017
category Added I/O blogpost Apr 9, 2018
io16 solved vulnerability alert caused by an obsolete version of mustache โ€ฆ Nov 19, 2017
manifests Update manifest_webapp.json Oct 24, 2017
static Smart Home Made Easy Nov 9, 2018
.gitignore First Jekyll commit Oct 16, 2017
404.html First Jekyll commit Oct 16, 2017
CNAME Create CNAME Oct 18, 2017
Gemfile Update Gemfile Oct 20, 2017
LICENSE First Jekyll commit Oct 16, 2017
OneSignalSDKUpdaterWorker.js Service Worker for our WebApp Oct 20, 2017
OneSignalSDKWorker.js Service Worker for our WebApp Oct 20, 2017
README.md Update To Do List Sep 5, 2018
_config.yml Update Google Analytics ID Nov 16, 2017
about.md Updated the telegram group link Oct 11, 2018
blog.html Added header for the first page Oct 19, 2017
feed.xml First Jekyll commit Oct 16, 2017
feedbackform.md New feedback form Nov 8, 2018
gh-md-toc Added TOC Nov 6, 2017
heroes.md Hall of Fame introduction Sep 5, 2018
manifest.webapp Manifest for our PWA Oct 24, 2017
projects.md New infos for CFP Sep 30, 2018
sitemap.xml Fixed sitemap.xml generation for project entries (#14) Nov 1, 2017
sw.js Update sw.js Nov 9, 2018

README.md

GDG Pisa's public website ๐ŸŒŽ

License Twitter

readme screenshot

Welcome to the Google Developer Group Pisa public website ๐ŸŒŽ The website is written with Jekyll and hosted on GitHub Pages.

The website is publicly available on https://gdgpisa.it/.

Feel free to fork โธ‘ or star โญ๏ธ this repo! Contributions are really appreciated. Please have a look at the Contributing Guidelines or at the TODO list down there. You can easily start having a look at our Issues.

Don't know where to start? ๐Ÿค” have a look at our help wanted or good first issue tickets.

Feature ๐Ÿ’…

  • Material Designed (based on hcz-jekyll-blog theme) ๐ŸŽจ
  • Mobile Responsive ๐Ÿ“ฑ
  • Push Notifications ๐Ÿ”” (with OneSignal)
  • Progressive Web App ready ๐Ÿ–ฅ
  • HTML5 Cache support โ™ป๏ธ
  • Awesome Community behind ๐Ÿค

Getting Started (building the website locally) ๐Ÿ› 

To get starting developing, we really recommend to clone the website locally and start developing on your machine.

This will allow you to preview what the generated site will look like in your browser locally. Jekyll comes also with a auto-regenerate feature, this will allow you to quickly iterate over different changes to the website (useful if you're touching the CSS files). More info about the auto-regenerate feature on the Jekyll usage page.

Linux

  1. Install Ruby with your package manager.
Debian
sudo apt install ruby

ArchLinux
sudo pacman -S ruby
  1. Clone this repository (you need git installed).
git clone https://github.com/gdgpisa/gdgpisa.github.io.git
cd gdgpisa.github.io/
  1. To configure gems user-wide add the following line to your shell configuration files, for example ~/.bashrc or ~/.zshrc
export GEM_HOME=$(ruby -e 'print Gem.user_dir')
  1. Open your terminal and install jekyll and bundler
gem install jekyll
gem install bundler
  1. To run executable gems, without typing the full location, run the following command or add it to your shell configuration files, for example ~/.bashrc or ~/.zshrc.
PATH=$(ruby -e 'print Gem.user_dir')/bin:$PATH
  1. To install gems into GEM_HOME
bundle install
  1. Serve the website with the following command,
bundle exec jekyll serve

You should be able to see the local website at http://127.0.0.1:4000

Mac OS

To be able to build the site locally, you need Homebrew installed. Please follow this link to install Homebrew

  1. Clone this repository (you need git installed).
git clone https://github.com/gdgpisa/gdgpisa.github.io.git
cd gdgpisa.github.io/
  1. Open your terminal and install ruby, jekyll and bundler (skip the related command if you already have the package installed).
brew install ruby
sudo gem install jekyll
sudo gem install bundler
  1. Serve the website with the following command
bundle exec jekyll serve

You should be able to see the local website at http://127.0.0.1:4000/.

Windows

You must have git for windows installed in your system.

  1. Download and install Ruby and Rubygems using rubyInstaller for windows

  2. Using git bash, clone this repository.

git clone https://github.com/gdgpisa/gdgpisa.github.io.git
cd gdgpisa.github.io/
  1. On your terminal install jekyll and bundler
gem install jekyll bundler
  1. Serve the website with the following command
bundle exec jekyll serve

You should be able to see the local website at http://127.0.0.1:4000/.

Docker

  1. Be sure to have Docker installed on your local machine
Ubuntu
sudo apt-get install docker

ArchLinux
sudo pacman -S docker
  1. Clone this repository (you need git on your machine)
git clone https://github.com/gdgpisa/gdgpisa.github.io.git
cd gdgpisa.github.io/
  1. Run a Docker container with jekyll/jekyll image and serve the site
docker run --rm -it \
-p 4000:4000 -v "$PWD":/srv/jekyll \
jekyll/jekyll jekyll serve

You should be able to see the local website at http://127.0.0.1:4000

This command will download the jekyll/jekyll image from Docker Hub and build a container from that image.
Container port 4000 is linked to localhost:4000, so that you can access the site from that address.
Every time this container is executed, it'll automatically do a bundle install, thus retrieving all Gem dependencies before building and serving.

Writing a post ๐Ÿ“

To add a new post to the blog page, you need to create a new file in the _post folder. Please follow the naming of the file, like:

2017-10-10-hello-world.md

The structure of the blog post file should be as following:

---
layout: post
title: <TITLE OF YOUR BLOGPOST>
date:   <DATE OF YOUR BLOGPOST LIKE '2017-10-10 13:50:39'>
categories: <LIST OF SPACE SEPARATED CATEGORIES>
---

<BODY OF YOUR BLOGPOST>

Updating the feedback form shortlink โ†ช๏ธ

We are using a dynamic shortlink for the events feedback form. The shortlink is http://bit.ly/gdgfback. To change the destination of the shortlink please edit the feedbackform.md file:

---
layout: page
redirect_to: "http://example.com"
permalink: /feedbackform/
---

And change the redirect_to field to the desired one.

Website Structure ๐Ÿ—บ

Here a short description of the project structure:

Contributing ๐Ÿค

Feel free to contribute to this project! You can have a look at our Contribution guidelines if you don't know how to proceed.

Feel free to open a issue or submit a new pull request โค๏ธ

Here a short TODO list:

  • Create the hall of fame page.
  • Writing Linux setup steps to this Readme.
  • Writing Windows setup steps to this Readme.
  • Fix naming issues (mix of - and _ in file naming).
  • Clean-up the static folder.

License ๐Ÿ“„

This project is licensed under the MIT License - see the License file for details