Difference between revisions of "Workflow"

From CSE330 Wiki
Jump to: navigation, search
(Komodo Edit)
Line 29: Line 29:
 
# Save your ''*.pem'' file to'' ~/.ssh/cse330.pem'':
 
# Save your ''*.pem'' file to'' ~/.ssh/cse330.pem'':
 
#: <source lang="bash">$ mv /path/to/your/cse330.pem ~/.ssh/cse330.pem</source>
 
#: <source lang="bash">$ mv /path/to/your/cse330.pem ~/.ssh/cse330.pem</source>
# Run the following command:
+
# Run the following command to add the key to your SSH agent:
 
#: <source lang="bash">$ ssh-add ~/.ssh/cse330.pem</source>
 
#: <source lang="bash">$ ssh-add ~/.ssh/cse330.pem</source>
 +
#: For more information on ''ssh-add'', see [http://www.openbsd.org/cgi-bin/man.cgi?query=ssh-agent the manual].
  
 
===== Windows =====
 
===== Windows =====
Line 37: Line 38:
  
 
==== Configure your Server Settings in Komodo ====
 
==== Configure your Server Settings in Komodo ====
 +
 +
Once you have your public key in your SSH agent (if applicable), follow these steps to tell Komodo how to connect to your remote instance.
  
 
# Open the Komodo Edit preferences.  In Windows, this is '''Edit -> Preferences'''; in Mac OS X, this is '''Komodo -> Preferences'''.
 
# Open the Komodo Edit preferences.  In Windows, this is '''Edit -> Preferences'''; in Mac OS X, this is '''Komodo -> Preferences'''.
Line 42: Line 45:
 
# For Server Type, select '''SFTP'''.  (Since you have an SSH server running, you will be able to connect to your instance via SFTP.)
 
# For Server Type, select '''SFTP'''.  (Since you have an SSH server running, you will be able to connect to your instance via SFTP.)
 
# Name it something like '''CSE 330 Cloud Instance'''.
 
# Name it something like '''CSE 330 Cloud Instance'''.
# Enter the details of your instance, including your hostname and username. '''If you are using Public Key Authentication, leave your password empty.'''  Unless you explicitly changed your SSH port, your port will be '''22'''.
+
# Enter the details of your instance, including your hostname and username.
 +
#* If you are using Public Key Authentication, leave your password empty.
 +
#* Unless you explicitly changed your SSH port, your port will be '''22'''.
 
# Your default path will be where you want to save the files you upload.  Generally, this should be the root of your web server.
 
# Your default path will be where you want to save the files you upload.  Generally, this should be the root of your web server.
 
#: [[File:Workflow-3.png]]
 
#: [[File:Workflow-3.png]]
 
# Press '''Add''' to save the server information, and then press '''OK'''.
 
# Press '''Add''' to save the server information, and then press '''OK'''.
 +
# To test whether Komodo is able to successfully connect to your server, choose '''File -> Open -> Remote File'''.  Select ''CSE 330 Cloud Instance'' from the drop-down menu.  You should be able to see a list of files in your public_html directory.
  
 
== SourceTree ==
 
== SourceTree ==

Revision as of 18:42, 18 March 2013

The few minutes it takes to optimize your workflow will be the best few minutes you will spend in CSE 330 and your career. It is remarkable how many hours you can save just by using the best interface for text editing and deployment.

Komodo Edit

Komodo.png

This semester in CSE 330, we will be using Komodo Edit as our editor of choice. We chose this editor because:

  1. It is free for everyone.
  2. It runs on Windows, Mac OS X, and Linux.
  3. It supports all of the languages we will be using in this class.
  4. It has a decent amount tools like auto-completion that will speed up your workflow.

Installation

Komodo Edit is already installed on the CEC lab machines. If you prefer to use your personal computer, download it from the web site: http://www.activestate.com/komodo-edit

Connecting Komodo to your Remote Instance

With a little time spend on configurations and installing a plugin, Komodo Edit enables you to edit files on your desktop and then upload those files directly to your remote instance.

Adding SSH Public Key to Keychain

In order for Komodo to connect to your instance using SSH Public Key Authentication, you need to add your public key permanently to your SSH agent utility. Instructions are below on how to do this in OS X and Windows. You may skip to the next section if you are using password-based authentication.

Mac OS X
  1. Open Terminal.
  2. Save your *.pem file to ~/.ssh/cse330.pem:
    $ mv /path/to/your/cse330.pem ~/.ssh/cse330.pem
    
  3. Run the following command to add the key to your SSH agent:
    $ ssh-add ~/.ssh/cse330.pem
    
    For more information on ssh-add, see the manual.
Windows

under construction

Configure your Server Settings in Komodo

Once you have your public key in your SSH agent (if applicable), follow these steps to tell Komodo how to connect to your remote instance.

  1. Open the Komodo Edit preferences. In Windows, this is Edit -> Preferences; in Mac OS X, this is Komodo -> Preferences.
  2. In the menu on the left, choose Servers.
  3. For Server Type, select SFTP. (Since you have an SSH server running, you will be able to connect to your instance via SFTP.)
  4. Name it something like CSE 330 Cloud Instance.
  5. Enter the details of your instance, including your hostname and username.
    • If you are using Public Key Authentication, leave your password empty.
    • Unless you explicitly changed your SSH port, your port will be 22.
  6. Your default path will be where you want to save the files you upload. Generally, this should be the root of your web server.
    Workflow-3.png
  7. Press Add to save the server information, and then press OK.
  8. To test whether Komodo is able to successfully connect to your server, choose File -> Open -> Remote File. Select CSE 330 Cloud Instance from the drop-down menu. You should be able to see a list of files in your public_html directory.

SourceTree

under construction

Starting a Project

When you start a new project, whether individual or group, you should create a new directory and a new Komodo Project file.

  1. Create a new directory in your repository named after the project you will be starting (e.g., fileshare).
  2. In Komodo, choose Project -> New Project (or press shift-ctrl-N).
  3. Navigate to the directory you just created, enter a name for the project (e.g., FileShare.komodoproject), and press "Save".
  4. You should now see a window like this:
    Workflow-1.png
  5. Press ctrl-N (or cmd-N) to create a new file. Save it in your project. For example, you could create a page named index.html with the Quick and Easy Page Layout:
    Workflow-2.png
  6. Continue creating and editing the files from your site.
    Tip: To change between files without using a mouse, press ctrl-PageUp and ctrl-PageDown (cmd instead of ctrl on OS X). Many computers without explicit PageUp and PageDown buttons bind them to fn-Up and fn-Down. For example, on a MacBook Pro, to change to the next tab, you would press three keys: fn+cmd+down.
  7. When you are ready, upload your files to your remote server. To do this, go to File -> Save as Other -> Remote File.