Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gdgpisa/gdgpisa.github.io
Public website on github-pages for GDG Pisa 🌎🇮🇹💻
https://github.com/gdgpisa/gdgpisa.github.io
amp community community-project gdg gdg-pisa gdg-x google jekyll jekyll-site material-design material-theme notifications onesignal onesignal-notifications pwa pwa-apps website
Last synced: about 13 hours ago
JSON representation
Public website on github-pages for GDG Pisa 🌎🇮🇹💻
- Host: GitHub
- URL: https://github.com/gdgpisa/gdgpisa.github.io
- Owner: gdgpisa
- License: mit
- Created: 2016-05-19T10:30:55.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2024-12-16T18:10:30.000Z (2 months ago)
- Last Synced: 2024-12-16T19:28:23.980Z (2 months ago)
- Topics: amp, community, community-project, gdg, gdg-pisa, gdg-x, google, jekyll, jekyll-site, material-design, material-theme, notifications, onesignal, onesignal-notifications, pwa, pwa-apps, website
- Language: JavaScript
- Homepage: http://gdgpisa.it
- Size: 60.9 MB
- Stars: 15
- Watchers: 9
- Forks: 8
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# GDG Pisa's public website 🌎
[](https://opensource.org/licenses/MIT) [](http://twitter.com/gdgPisa)
* [GDG Pisa's public website](#gdg-pisas-public-website-)
+ [Feature](#feature-)
+ [Getting Started (builing the website locally)](#getting-started-builing-the-website-locally-)
+ [Linux](#linux)
+ [Mac OS](#mac-os)
+ [Windows](#windows)
+ [Docker](#docker)
+ [Writing a post](#writing-a-post-)
+ [Updating the feedback form shortlink](#updating-the-feedback-form-shortlink-️)
+ [Updating the service worker](#updating-the-service-worker-)
+ [Website Structure](#website-structure-)
+ [Contributing](#contributing-)
+ [License](#license-)
Welcome to the Google Developer Group Pisa public website 🌎 The website is written with [Jekyll](https://jekyllrb.com/) and hosted on [GitHub Pages](https://pages.github.com/).
The website is publicly available on [https://gdgpisa.it/](https://gdgpisa.it/).
Feel free to fork ⸑ or star ⭐️ this repo! Contributions are really appreciated. Please have a look at the [Contributing Guidelines](.github/CONTRIBUTING.md) or at the [TODO](#contributing-) list down there. You can easily start having a look at our [Issues](https://github.com/gdgpisa/gdgpisa.github.io/issues).
**Don't know where to start?** 🤔 have a look at our [**help wanted**](https://github.com/gdgpisa/gdgpisa.github.io/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) or [**good first issue**](https://github.com/gdgpisa/gdgpisa.github.io/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) tickets.
## Feature 💅
* Material Designed (based on [hcz-jekyll-blog](https://github.com/codeasashu/hcz-jekyll-blog) theme) 🎨
* Mobile Responsive 📱
* [Progressive Web App](https://developers.google.com/web/progressive-web-apps/) 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](https://jekyllrb.com/docs/usage/).
### Linux
1. Install [Ruby](https://www.ruby-lang.org/en/) with your package manager.
```
Debian
sudo apt install ruby ruby-dev
ArchLinux
sudo pacman -S ruby
```
2. Clone this repository (you need `git` installed).
```
git clone https://github.com/gdgpisa/gdgpisa.github.io.git
cd gdgpisa.github.io/
```
3. 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')
```
4. Open your terminal and install `jekyll` and `bundler`
```
gem install jekyll
gem install bundler
```
5. 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
```
6. To install gems into `GEM_HOME`
```
bundle install
```
7. 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](http://127.0.0.1:4000)
### Mac OS
To be able to build the site locally, you need [Homebrew](https://brew.sh/index.html) installed. [Please follow this link to install Homebrew](https://brew.sh/index.html)
1. Clone this repository (you need `git` installed).
```
git clone https://github.com/gdgpisa/gdgpisa.github.io.git
cd gdgpisa.github.io/
```
2. 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
```
3. 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/](http://127.0.0.1:4000/).
### Windows
You must have [git](https://git-scm.com/downloads) for windows installed in your system.
1. Download and install **Ruby** and **Rubygems** using [rubyInstaller for windows](https://rubyinstaller.org/)
2. Using git bash, clone this repository.
```bash
git clone https://github.com/gdgpisa/gdgpisa.github.io.git
cd gdgpisa.github.io/
```
2. On your terminal install `jekyll` and `bundler`
```bash
gem install jekyll bundler
```
3. Serve the website with the following command
```bash
bundle exec jekyll serve
```
You should be able to see the local website at [http://127.0.0.1:4000/](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
```
2. Clone this repository (you need `git` on your machine)
```
git clone https://github.com/gdgpisa/gdgpisa.github.io.git
cd gdgpisa.github.io/
```
3. 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](http://127.0.0.1:4000)
This command will download the [`jekyll/jekyll`](https://hub.docker.com/r/jekyll/builder/) 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`](https://github.com/gdgpisa/gdgpisa.github.io/tree/master/_posts) 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:
```markdown
---
layout: post
title:
date:
categories:
---
```
## Updating the feedback form shortlink ↪️
We are using a **dynamic** shortlink for the events feedback form. The shortlink is [http://bit.ly/gdgfback](http://bit.ly/gdgfback). To change the destination of the shortlink please edit the [`feedbackform.md`](https://github.com/gdgpisa/gdgpisa.github.io/tree/master/feedbackform.md) file:
```markdown
---
layout: page
redirect_to: "http://example.com"
permalink: /feedbackform/
---
```
And change the `redirect_to` field to the desired one.
## Updating the Service Worker ⚙
Before committing an update in this repo, you should install [Workbox CLI](https://developers.google.com/web/tools/workbox/modules/workbox-cli) and update the Service Worker. To update it correctly, run `workbox generateSW static/js/workbox-config.js` from your shell in the root of this repo.
### ⚠️ In case of error during the generation
If during the generation appears an error of invalid configuration, edit `static/js/workbox-config.js` and remove the key `ignoreURLParametersMatching` and its values.
## Website Structure 🗺
Here a short description of the project structure:
* [`_config.yml`](https://github.com/gdgpisa/gdgpisa.github.io/tree/master/_config.yml) **Jekyll config file**, used to provide projectwise configuration.
* [`_data`](https://github.com/gdgpisa/gdgpisa.github.io/tree/master/_data) Contains JSON files used to build pages
- [`_data/project.json`](https://github.com/gdgpisa/gdgpisa.github.io/tree/master/_data/project.json) Used to build the [/projects](https://gdgpisa.it/projects/) page.
- [`_data/heroes.json`](https://github.com/gdgpisa/gdgpisa.github.io/tree/master/_data/heroes.json) Used to build the [/heroes](https://gdgpisa.it/heroes/) page.
- [`_data/social.json`](https://github.com/gdgpisa/gdgpisa.github.io/tree/master/_data/social.json) Used to create the social buttons.
- [`_data/urls.json`](https://github.com/gdgpisa/gdgpisa.github.io/tree/master/_data/social.json) Used to create the navigation bar.
* [`_includes`](https://github.com/gdgpisa/gdgpisa.github.io/tree/master/_includes) Static HTML files that will be used to generate web pages
- [`_includes/analytics.html`](https://github.com/gdgpisa/gdgpisa.github.io/tree/master/_includes/analytics.html) Google Analyics snippet.
- [`_includes/css.html`](https://github.com/gdgpisa/gdgpisa.github.io/tree/master/_includes/css.html) CSS Includes go here.
- [`_includes/header.html`](https://github.com/gdgpisa/gdgpisa.github.io/tree/master/_includes/header.html) Header for all pages is here, including the homepage with the big image.
- [`_includes/footer.html`](https://github.com/gdgpisa/gdgpisa.github.io/tree/master/_includes/footer.html) Footer for all pages is here.
- [`_includes/js.html`](https://github.com/gdgpisa/gdgpisa.github.io/tree/master/_includes/js.html) JS Includes go here.
- [`_includes/main.html`](https://github.com/gdgpisa/gdgpisa.github.io/tree/master/_includes/main.html) Main content is here (whatever is between header and footer).
- [`_includes/meta.html`](https://github.com/gdgpisa/gdgpisa.github.io/tree/master/_includes/meta.html) META tags go here.
- [`_includes/navigation.html`](https://github.com/gdgpisa/gdgpisa.github.io/tree/master/_includes/navigation.html) Navigation menu is here.
- [`_includes/share-page.html`](https://github.com/gdgpisa/gdgpisa.github.io/tree/master/_includes/share-page.html) Share buttons (after content) are here.
- [`_includes/social_links.html`](https://github.com/gdgpisa/gdgpisa.github.io/tree/master/_includes/social_links.html) Social buttons in the header are generated here.
* [`_layouts`](https://github.com/gdgpisa/gdgpisa.github.io/tree/master/_layouts) Layout files used to create pages
- [`_layouts/default.html`](https://github.com/gdgpisa/gdgpisa.github.io/tree/master/_layouts/default.html) **Default layout**, all the pages follow this structure. All the other layouts will just add elements to this layout.
- [`_layouts/page.html`](https://github.com/gdgpisa/gdgpisa.github.io/tree/master/_layouts/page.html) **Page layout**, used to render static pages (like the [About](http://gdgpisa.it/) page).
- [`_layouts/post.html`](https://github.com/gdgpisa/gdgpisa.github.io/tree/master/_layouts/post.html) **Blogpost layout**, used to render blogposts from the [`_posts`](https://github.com/gdgpisa/gdgpisa.github.io/tree/master/_posts) folder).
- [`_layouts/posts_by_gategory.html`](https://github.com/gdgpisa/gdgpisa.github.io/tree/master/_layouts/posts_by_gategory.html) Layout used when user clicks on a specific category.
- [`_layouts/project.html`](https://github.com/gdgpisa/gdgpisa.github.io/tree/master/_layouts/project.html) **Projects layout**, used to display seminars with Cards.
- [`_layouts/heroes.html`](https://github.com/gdgpisa/gdgpisa.github.io/tree/master/_layouts/heroes.html) **Hall of Fame layout**, used to display our Heroes.
* [`blog/index.html`](https://github.com/gdgpisa/gdgpisa.github.io/tree/master/blog/intex.html) Index file for the [blog](https://gdgpisa.it/blog/) page. Used by the [`jekyll-paginate`](https://jekyllrb.com/docs/pagination/).
* [`category`](https://github.com/gdgpisa/gdgpisa.github.io/tree/master/category) Contains one file for every **category**. Please add files here before using new categories in blogposts.
* [`manifests`](https://github.com/gdgpisa/gdgpisa.github.io/tree/master/manifests) Contains manifests file for the PWA.
* [`static`](https://github.com/gdgpisa/gdgpisa.github.io/tree/master/static) Contains static files served directly by Jekyll (Images, JS, CSS, etc.)
- [`static/css`](https://github.com/gdgpisa/gdgpisa.github.io/tree/master/static/css) CSS and SASS files goes here. `.scss` file starting with double `---` will be built by Jekyll and the resulted `.css` file will be available in the [`static/css/_site`](https://github.com/gdgpisa/gdgpisa.github.io/tree/master/static/css/_site) folder. Please note that this project is using [Bootstrap Material Design](https://mdbootstrap.com/), feel free to use the CSS classes you need.
- [`static/img`](https://github.com/gdgpisa/gdgpisa.github.io/tree/master/static/img) Images goes here
- [`static/js`](https://github.com/gdgpisa/gdgpisa.github.io/tree/master/static/img) Javascript files goes here.
* [`about.md`](https://github.com/gdgpisa/gdgpisa.github.io/tree/master/about.md) **About page**, Markdown file used to create it.
* [`feed.xml`](https://github.com/gdgpisa/gdgpisa.github.io/tree/master/feed.xml) XML File used to create the RSS feed.
* [`projects.md`](https://github.com/gdgpisa/gdgpisa.github.io/tree/master/projects.md) **Projects page**, Markdown file used to create it. For cards creation refer to the project layout file.
* [`heroes.md`](https://github.com/gdgpisa/gdgpisa.github.io/tree/master/heroes.md) **Heroes page**, Markdown file used to create it. For cards creation refer to the project layout file.
* [`feed.xml`](https://github.com/gdgpisa/gdgpisa.github.io/tree/master/feed.xml) XML File used to create the RSS feed.
* [`feedbackform.md`](https://github.com/gdgpisa/gdgpisa.github.io/tree/master/feedbackform.md) **Feedback form** redirect page, used to handle the feedback form QR code.
* [`sw.js`](https://github.com/gdgpisa/gdgpisa.github.io/tree/master/sw.js) Service Worker used for PWA purpose.
## Contributing 🤝
Feel free to contribute to this project! You can have a look at our [Contribution guidelines](.github/CONTRIBUTING.md) if you don't know how to proceed.
Feel free to [open a issue](https://github.com/gdgpisa/gdgpisa.github.io/issues/new) or [submit a new pull request](https://github.com/gdgpisa/gdgpisa.github.io/pulls) ❤️
Here a short TODO list:
- [x] Create the *hall of fame* page.
- [x] Writing Linux setup steps to this Readme.
- [x] Writing Windows setup steps to this Readme.
- [ ] Fix naming issues (mix of `-` and `_` in file naming).
- [x] Clean-up the `static` folder.
## License 📄
This project is licensed under the MIT License - see the [License](License) file for details