These are the source files for the Code for Germany Website. This readme will guide you to use them and collaborate with us on its contents.
First clone this git repository by invoking the following in a desired folder on your shell interpreter (console, terminal, command line, REPL), presuming you know how to get there:
$ git clone https://github.com/okfde/codefor.de.git
You can also append another foldername of your desire to the command.
Then change into the folder, i.e.:
$ cd codefor.de
Now it is about time to install the required gems. There are several ways to accomplish this.
First of all you need an up-to-date version of the Ruby Programming Language Interpreter. This can either be installed through your favourite distributions package manager, or ...
You can use RVM to sandbox the Gems needed for this project
in a Gemset. To do so you will need to install RVM first. When you successfully
installed RVM make sure you also installed the Ruby version defined for this
project in .ruby-version.
To initialize the Gemset environment leave the project folder once and then return back to it:
$ cd ..
$ cd codefor.deFinally, after pulling the latest commits from the remote repository run the
bundle command to ensure you have the latest Gems installed into you Gemset.
Preferably you will want to do pretty much the same, but with rbenv.
You can use Bundler to install the required gems system-wide:
$ bundle install
Simply install the github-pages gem:
$ gem install github-pages
All required dependencies will be installed automatically. You will need root permissions to do that in most cases.
If you don't want to install all the gems system-wide you can install them just for the project:
$ bundle install --path vendor/bundle
On OS X you have to configure the following options to build nokogiri before running bundle install:
$ bundle config --local build.nokogiri --with-xml2-include=/usr/include/libxml2 --with-xml2-lib=/usr/lib --with-xslt-dir=/usr
After that you can just run bundle install every time you want to reinstall or update the installation because Bundler will remember the options you configured.
Now build the site and serve it:
$ jekyll serve -w
If you did the installation with Bundler you have to use this command instead:
$ bundle exec jekyll serve -w
To get a fully working website running, especially if you added new Twitter handles somewhere, you have to perform some further tasks.
There's a Python script to cache all GitHub avatars into the repository.
optional
Similiar to rbenv or nvm, you can create safe installations of Python by using Virtual Environments. Or even an Virtual Environment Wrapper, but the first option will be enough for now.
$ virtualenv .pyenv
$ source .pyenv/bin/activate
Install the following:
$ pip install pyyaml requests
And then just execute:
$ python download_avatars.py
note Don't forget to
deactivatethe virtual environment afterwards, if appropriate.
Don't forget to commit the downloaded images.
Why did we mention NVM up there?
So we're already depending this project on Ruby and Python, why not adding another layer of complexity? Like Node.js, the JavaScript interpreter for servers.
There are two basic options, which you can discover, if you feel adventurous:
- Find and use
gulpand a correspondingjekyllplugin to automate the avatar scraping upon site regeneration. - Feel free to fiddle around with
bowerto manage the static assetts and dependencies.
Text on project teasers is cut off after \n\n. Alternatively, include a dedicated excerpt: "<TEXT>"
in the frontmatter to override.
Images are crop-centered. You can fine tune their appearance by providing a specific crop image
through imgname-teaser: "<[RELATIVE] PATH TO IMAGE>" in the same frontmatter.
note Please use mobile friendly filesizes for images.
Consider our Contribution Guidelines.
Legit, on the website who's source you are looking at, http://codefor.de and Twitter.
Licensed 2014