Skip to content

Latest commit

 

History

History
97 lines (62 loc) · 1.58 KB

README.md

File metadata and controls

97 lines (62 loc) · 1.58 KB
Raw

Courses website

http://courses.cecilitse.org/

Made with Foundation & Middleman

This project also generates PDF course documents.

Getting Started

Requirements

  • Python & pipenv
  • NodeJS & Yarn
  • Ruby & Bundler

Installation

Install WeasyPrint via pipenv:

$ pipenv install

Install required gems:

$ bundle install

Install default yarn packages:

$ yarn install

Usage

Activate Python virtualenv:

$ pipenv shell

Start the server:

$ middleman server

Generate a course PDF:

$ bin/courses generate COURSE_NAME [BASE_URL]

This generates a PDF at the root directory of Courses. Filename is based on the course name.

Preview

Before generating a course PDF, you can have a preview of the document in a web browser.

Open a web browser and go to http://localhost:4567/programs/COURSE_NAME.html. That's it!

Deployment

Filst time, initialize the submodule:

$ git submodule init

Build the application:

$ middleman build --no-clean

Deploy on GitHub pages:

$ middleman deploy

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Added some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

License

Courses is released under two licenses:

  • GPL License for sources
  • Creative Commons Attribution-ShareAlike License for content