Giter VIP home page Giter VIP logo

2018-web's Introduction

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!!

2018-web's People

Contributors

abrahamvarricatt avatar antonnguyen avatar avolkov avatar bigbitbus avatar cfournie avatar cormier avatar di avatar dorianpula avatar elainewong avatar erikwright avatar fdosani avatar frdeso avatar ian-whitestone avatar jasonmwhite avatar jnmclarty avatar maximest-pierre avatar myles avatar raamana avatar sachinkagarwal avatar shagunsodhani avatar topspinj avatar

Watchers

 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.