Skip to content
This repository has been archived by the owner on May 14, 2022. It is now read-only.

OpenThessaloniki/openindex

Repository files navigation

An Index for Open Data in Greece

Contributors and Maintainers

If you know your way with Github, editing and updating the index is very simple, just edit the _data/openindex.yaml file and send a Pull Request.

If you are a nooby check our wiki page, to get some extra help.

Web Developers

If you want to contribute to the development of this site you first need to setup your environment based on the project's requirements.

The Stack

  • Node 0.10.x
  • Ruby If you're on OS X or Linux you probably already have Ruby installed; test with ruby -v in your terminal.
  • Grunt npm install -g grunt-cli
  • Bower npm install -g bower
  • Jekyll gem install jekyll

This project was built using Jekyll and is based on the JekyllBootstrap template, you don't need to be familiar with these tools to do most of the tasks.

Installing the project

First fork this repository and clone it to your local:

git clone git@github.com:YOUR_USERNAME/openthessaloniki.github.io.git
cd openthessaloniki.github.io

After cloning is finished you need to install the development dependencies:

npm install && bower install

Working with the project

You can launch a webserver and a Jekyll watch alltogether simply by running grunt:

grunt

The default Grunt task will:

  • Launch a jekyll watch and auto-build on every file change.
  • Launch a local static webserver on port 9003.
  • Open your browser on http://localhost:9003

Assets and pages locations

  • Edit styles from the assets/css/main.css file.
  • Edit the layout from the _includes/themes/twitter/ folder.
  • The project's homepage is the file index.html in the root folder.
  • Edit the markup for the Categories items in the _includes/widgets/ folder.
  • All the site's data are in the _data/ folder.

Colophon

License

Copyright (c) 2014 SKGTech x OpenThessaloniki. Licensed under the MIT license.