Repository files navigation

This is the source code forhttp://tutorials.codebar.io/

This is aGitHub Pages repo, so you can render the pages withJekyll.First make sure toinstall the version of Rubyindicated in.ruby-version, as well as thebundler gem. Then:

1. bundle install, which will install Jekyll
2. bundle exec jekyll serve --watch
3. go tohttp://localhost:4000/

(you could also use your favourite manager,chruby,rbenv,rvm, etc. Seeinstructions forrvm at the end of this README)

If you are just updating or adding new tutorials, follow steps 1 to 3 only.

If you also want to make changes to the structure of the site (i.e. if you wantto modify the site's Javascript files) and run the tests, you need to installNode (follow the link for installationinstructions). Then:

$ npm install$ gulp

and go tohttp://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 ofthis repo, it will concatenate and minify the files inside thejavascripts-dev folder, as well as watch for changes in that folder. Theconcatenated and minified JS file will be generated inside thejavascriptsfolder. You can push both folders when you are finished with your changes.GitHub pages will then generate the site in production with whatever isinside thejavascripts folder.

You can go to the generalcodebar Slack channel here or thededicatedtutorials channel here. Use it to get in touchand chat to other codebar students/coaches, or if you need help.

If you are not on Slack usethis link to get an invite.

We encourage you to contribute with your suggestions and corrections. Head to ourissues page and open a new issue orhelp on the existing ones.

1. All tutorials get the students to build something that they are able to show around at the end of the workshop.

2. 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 issomething that could be added then please include it.
     • Further reading - Again this is not always required but if you feelthere was something in the tutorials that could be covered in moredepth then please include any good reading materials/videos or extratutorials.

3. Repetition is good. A tutorial can contain multiple exercises that ask thestudents to take similar steps (e.g. for HTTP Requests one exerciseintroduces GET, another has GET and POST etc).

4. 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 beconfusing.

5. Before starting to write a new tutorial please speak with someone fromcodebar to see whether it is of interest to students.

• Add a folder with your exercise files inside the tutorial folder. For example, for Javascript lesson 3:

js/lesson3/├── assets/├── files/│   ├── index.html│   ├── jquery.js│   ├── script.js│   └── style.css└── tutorial.md

• Add a frontmatter variablefiles to the tutorial page with a list of the files you added,including folder name:

---layout:pagetitle:Introduction to jQueryfiles:  -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 justdownload:

Download the files that you will need to work through the example[here](download).

And you're done. Commit and push as usual.

Another way of installing the project dependencies is viaRVM.Follow thequick installation guide and then run:

$ rvm install 2.2.1# inside `codebar/tutorials` folder$ rvm gemset use codebar-tutorial --create$ gem install bundler -v 1.17.3$ bundle install$ jekyll serve# go to http://127.0.0.1:4000/

If you also want to make changes to the JavaScript of the site, you'll need to haveNode installed.This can be done with a tool likeNVM.

codebar Tutorials are released under theAttribution-NonCommercial-ShareAlike 4.0 International (CC BY-NC-SA 4.0).