/2018-web

Primary LanguageJupyter Notebook

Website README

Welcome to the Pycon Canada 2018 website source code! If you are reading this, it is likely that you are a volunteer who wants to help out. Let's get started shall we?

Requirements

Python 3.6.6
NodeJS 8.11.4

First off, you'll need to have the above tools installed on your system. When this project (website) was started, a major motivation was to use Python 3. Besides that, we just stuck with the versions available on our host - Netlify.

Next, you'll want to clone the repository to your local system. If you want to submit patches to improve the site, consider forking the project and sending us a pull request on Github. No promises that we'll accept every suggestion, but when we do, you'll be able to have a nice warm and fuzzy feeling that you helped make Pycon Canada that much better! :)

Once the project is cloned to your local system, you'll want to build the site. Just run the following command,

$ ./build.sh

This will install all the NPM and Python dependencies we need. It will also build the site and place it inside a new output/ folder inside your project directory.

At this point you can run,

$ npm run start

To see the site running at http://localhost:3000/ ( Ctrl + C to cancel the local server)

The above command will compile our SASS into CSS using gulp, run the nikola build command and open up browserSync with your default browser.

We put all our SASS stuff inside the src/ folder. Gulp will then process it into CSS and put it inside a top-level files/ folder. Nikola will use this as static material and copy it over to the output/ directory.

If you haven't guessed it by now, we build most of the site using Nikola, the static site generator - made with Python! :)

About Pull Requests

We've setup Netlify to use branch previews. That means if you send a PR, Netlify will build and actually host a branch-specific version of the site. The link to it will be added as a Check (or whatever Github is calling it, these days). It means, instead of guessing, we can preview suggestions and comment on them. So come on ahead and help make this an awesome website & conference!!