eyalr0/csu-il

Computer Science Unplugged Israel

Computer Science Unplugged IL

Website: http://www.csunplugged.org.il

Based on Computer Science Unplugged program. Designed to help teach basic principals of computer science to kids (but also grown ups).

All of the lessons are in Hebrew, most of them were translated by Benny Chor and Shimon Schocken.

Contribution

Wanna contribute to the project ? Yeah !!

The website is powered by Node.js, Harpjs and Twitter bootstrap. Feel free to fork the repository and hack on it. When you're done, send us a pull request and we'll add the change.

What we need ?

• Help with design. Get rid of the vanilla bootstrap look.
• Going through the lessons and constantly improve them.
• Anything else, checkout the Github issues page

Requirements

• Node.js

Installing and running

Download a local copy of the code. Go to the project root folder and enter:

$ npm install
$ npm start

Open your browser at http://localhost:8080.

Deploying

Website runs on Github pages. The deployment process is done automatically by Travis-ci in a process described here. Just commit code to master branch and it's deployed.

Adding lessons

For simplicity, lessons are written in Markdown and rendered to HTML on the fly. If Markdown syntax is not enough, you can use standard HTML tags like <img> or <table> inside the Markdown file and it should work just fine.

• Put each lesson in it's own folder under _public/lessons. Each folder name should be the lesson name in lowercase with dashes instead of spaces. For example, _public/lessons/binary-numbers.
• Lesson filename should be index.md. Harpjs knows how to take a markdown file and turn it into html automatically.
• Put any additional resources (lesson images for example) in the same lesson folder.
• Every lesson folder needs to contain a thumbnail.png file which is like the lesson logo that is shown on the lessons list page.
• Each lesson should be added to _public/lessons/_data.json file. Look at the format of previous lessons there and just add an entry.

Markdown is basically just plain text, therefor you can write it in any text editor (like notepad). Some text editors give you syntax highlighting as well. Few examples are Notepad++, MdCharm

What if I don't know all of the stuff you're talking about ?

If you wrote a good lesson or improved an existing one but you don't know how to add it, don't worry just send it over to [email protected] and we'll add it. Just don't send us PDF documents because it will make it hard for us to copy/paste.