Exercise 01 - Installation Instructions
(These are detailled instructions for the installation part of the Info 3 Startup Lab).
Which Computer to use?
As most of your colleagues in the former semesters completely ignored the new iMacs in our Web Technology lab and rather unfolded tiny notebooks in front of the 27’’ screens (which unfortunatley even cannot be used as an external monitor), I expect that you will also mainly use your personal computers for working on the exercises. If doing so, you need to make sure to have a set of software available.
If you become more proficient with standard tools like the command line and git, you will find it easier to switch between different computers and end up using the Macs at some point, anyway.
Text Editor
You need a good basic text editor. Wordpad, Word etc. are no options, as they add format information to the text. Eclipse is also not the best option, as it is rather heavyweight. Here are some suggestions:
- Atom: https://atom.io
- vi or vim - free, available everywhere, somewhat steeper learning curve - I recommend that you learn at least some basic vi commands as vi is available on all remote unix boxes you might happen to log in with ssh.
If you work on multiple platforms, you should choose one that is available on all of them.
Git & GitHub
- Git is the state-of-the-art Source Code Management Tool. Install the command line client for your platform, and maybe also a GUI Client, which can all be found here.
- Sign up on GitHub if you haven’t already done so. See also Setting up Git from GitHub for a comprehensive documentation.
- For other projects, you might want to use the HTW Projekteserver which offers you private repositorys, or any other service offering central repositories. Github also offers free private repositories for students.
- Github translates markdown files automatically to HTML - That’s how the README.md files you see in most repositories work. Read through the Markdown and maybe also the GitHub Flavored Markdown documentation.
Command Line
As a software developer, you need to know the basics of the command line - preferably in linux flavor!
You should at least be able to navigate the file system, look at directories, files and their contents, and start commands, at least your text editor, directly from there (which saves you the time of finding first your text editor and then the file again from some dreadful file open dialog).
See Learning the Shell for an intro and Tobi’s Cheat Sheet for the absolute basics including Windows specials -
Windows
As I said, preferably linux style. That is, if you’re working on Windows, rather learn the linux commands first and then adapt to the Windows equivalents. Or, better yet, install Cygwin which gives you a shell with all the linux commands on windows. You might also get away with just using git bash which comes with the windows git installation.
I have installed Cygwin and added the cygwin bin directory to the Windows path, which makes all linux commands from cygwin available in a windows “cmd” window - no need to remember that it would be dir instead of ls anymore!
You will run into issues on windows.
One last hint: Windows doesn’t have a real “home” directory. Thus, various tools put the ssh keys to different places. You should know where they are!
The Path
Speaking of that, you should understand the PATH - basically a list of directories the shell (the program that reads your commands in the command line) searches for the command.
Also, be aware that if you use Windows, programs like git, graphical git clients, cygwin and cmd have different opinions on where your ‘home directory’ is.
UML Drawing Tool
I will accept hand-drawn UML Diagrams for the Lab Reports! I even recommend drawing them by hand, as it gives you more time thinking about your design versus fighting the idiosyncrasies of a particular UML tool which will be out of date or for some other reason unusable next time you need one. And, as redrawing them is more work if you do them by hand, you might end up with simpler diagrams focussing on the most important aspects than if you have a tool.
Nevertheless, your colleagues from the previous semesters preferred UML tools. Well, go ahead and find one, if you must.
Ruby and Ruby on Rails Installation
Installing Ruby and Ruby on Rails has proven to be not as straightforward as one might wish for. I’ll give you some hints here; but as I hardly saw the same issue twice there’s no much point in trying to collect every possible issue here. On Linux and MacOS, I recommend using RVM.
A lot of issues come from the fact that you’ll need a C compiler on your machine.
Ruby in the Labs:
MacOs:
Als User Pfad der gems in ~/.bash_profile setzen und ein neues Terminal öffnen:
export GEM_HOME=$HOME/data
export GEM_PATH=$HOME/data/path
export GEM_SPEC_CACHE=$HOME/data/spec
export PATH=$PATH:$HOME/data/bin
Als User Rails installieren:
$ gem update
$ gem install rails
Versions
I usually try to work with the latest versions - the ruby and especially the rails world is evolving quickly. As of today (Oct 10th, 2017) this would be Ruby 2.4.2 and Rails 5.1.4 - so try to install these versions. The Windows Ruby Installer usually gives you an older version - use it at your own risk - but everything above Ruby 2.0.0 should be ok.
Local Installation on your machine
The programming examples will be in Ruby, and at the end of the semester we will dip into the Ruby on Rails Web Development framework and have a look at how Enterprise Application Patterns and agile best practices are built in there. As Ruby installation tends to be a pain on Windows, better start now. For MacOs and Linux, I recommend using rvm (ruby version manager) - all options are explained and linked from the ruby download page. There is also a newer tool, rbenv, which I haven’t tried.
After installing Ruby, install rails with
gem install rails
– see Rails installation for further information.
You should then be able to run
rails new my-first-app
cd my-first-app
rails server
in your shell and see a success page if you open https://localhost:3000 in your browser.
The tricky part about installing rails is, that you need c development tools on your machine. Yes, that means you need to install XCode on your Mac. And jump some hoops on Windows. This is because many of the additional packages (called gems in the ruby world) have to be compiled on your machine during installation.
If that works, you’re all set!
If not, at least try googling the particular issues you encounter during installation or get help from your peers. Stackoverflow is also a great resource. Also, taking the advice that you should understand the path, be able to navigate your files from the command line and be able to look into files is a great help during trouble shooting.