Giter Club home page Giter Club logo

nairobilug's Introduction

Nairobi GNU/Linux Users Group Website

This repository hosts the code for the Nairobi GNU/Linux Users Group website. We wanted a fun, nerdy and democratic way to give our community an online presence, so here we are.

Screenshot

The website is powered by Pelican โ€” a static site generator written in Python โ€” and uses a theme called Alchemy.

How to build

The easiest way to do this is in a Python virtual environment. We recommend using pyenv with pyenv-virtualenv to set one up. Luckily, pyenv has an automatic installer, pyenv-installer.

Virtual environment

Once you have pyenv installed, create a virtual environment to hold Pelican and its dependencies:

$ pyenv virtualenv nairobilug
$ pyenv activate nairobilug

This creates a virtual environment and then activates it.

Fork / Clone the repo

If you haven't already, clone this repo (or your version of it):

$ git clone --recurse-submodules [email protected]:nairobilug/nairobilug.or.ke.git

Install requirements

Use pip to install the list of dependencies (including Pelican) into your virtual environment:

$ pip install -r requirements.txt

Generate the website

Now that the dependencies exists, we can build:

$ make html

This takes the markdown files from the content/ directory and generates static HTML pages inside the output/ directory. That's it. No MySQL, no PHP, etc...

Preview the website

You can serve the generated site so it can be previewed in your browser:

$ make serve

And you should see the website if you visit http://localhost:8000.

Blog workflow

If you're interested in writing an article for the website, you need to:

  • Fork the nairobilug/nairobilug.or.ke repository
  • Write an article using markdown in the content directory
  • Push the changes to a topic branch, like why-i-love-linux, on your fork of the repository
  • Make a pull request against the master branch

Happy blogging!

Contact / Help

If you're having trouble with your setup, you can get help by creating an issue.

nairobilug's People

Contributors

adamn avatar adrianteri avatar alanorth avatar aloismbutura avatar bkmgit avatar bonfacekilz avatar eebrah avatar fredmanglis avatar ianmuchina avatar jasonrogena avatar kenju254 avatar kirembu avatar kkingori avatar muriukidavid avatar nj3ma avatar oguya avatar ooduor avatar poppingtonic avatar rwanyoike avatar urbanslug avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.