This is the source code for http://tutorials.codebar.io
bundle install, which will install Jekyll
bundle exec jekyll serve --watch
- go to http://localhost:4000
(you could also use your favorite manager,
rvm, etc. See
rvm at the end of this README)
If you are just updating or adding new tutorials, follow steps 1 to 3 only.
$ npm install $ gulp
and go to http://localhost:4000/test/specrunner.html to run the tests. Tests should be green.
Gulp is only used for development, not in production. In your local copy of this repo, it will concatenate and minify the files inside the
Getting in Touch
If you are not on Slack use this link to get an invite.
We encourage you to contribute with your suggestions and corrections. Head to our issues page and open a new issue or help on the existing ones.
General tutorial rule
All tutorials get the students to build something that they are able to show around at the end of the workshop.
All tutorials follow a structure:
- Objectives - "In this tutorial we are going to look at..."
- Goals - "By the end of this tutorial you will have..."
- Then the exercises.
- Bonus - This is not always required but if you feel there is something that could be added then please include it.
- Further reading - Again this is not always required but if you feel there was something in the tutorials that could be covered in more depth then please include any good reading materials/videos or extra tutorials.
Repetition is good. A tutorial can contain multiple exercises that ask the students to take similar steps (e.g. for HTTP Requests one exercise introduces GET, another has GET and POST etc).
Explaining and getting the students to focus on one new thing at a time, presenting students with lots of new content and usage examples can be confusing.
Before starting to write a new tutorial please speak with someone from codebar to see whether it is of interest to students.
To add downloadable files to a new or existing tutorial:
js/lesson3/ ├── assets/ ├── files/ │ ├── index.html │ ├── jquery.js │ ├── script.js │ └── style.css └── tutorial.md
- Add a frontmatter variable
filesto the tutorial page with a list of the files you added, including folder name:
--- layout: page title: Introduction to jQuery files: - files/index.html - files/jquery.js - files/script.js - files/style.css ---
- In the copy of the tutorial, add your link to the files, making it point to just
Download the files that you will need to work through the example [here](download).
And you're done. Commit and push as usual.
$ rvm install 2.2.1 # inside `codebar/tutorials` folder $ rvm gemset use codebar-tutorial --create $ gem install bundler $ bundle install $ jekyll serve # go to http://127.0.0.1:4000
codebar Tutorials are released under the Attribution-NonCommercial-ShareAlike 4.0 International (CC BY-NC-SA 4.0).