Difference between revisions of "Workflow"

From CSE330 Wiki
Jump to navigationJump to search
 
(69 intermediate revisions by 7 users not shown)
Line 1: Line 1:
 
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.
 
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 ==
+
== Overview ==
  
−
[[File:Komodo.png|200px]]
+
There are going to be several aspects to our workflow in CSE 330, and we will be switching between multiple different programs.  Here is how they all fit together.
  
−
This semester in CSE 330, we will be using Komodo Edit as our editor of choice.  We chose this editor because:
+
=== Running Commands ===
  
−
# It is free for everyone.
+
''Mac OS X:'' You will be running commands on your local machine using '''Terminal''', which you can find in your Applications -> Utilities folder. You will be connecting to your server via SSH.
−
# It runs on Windows, Mac OS X, and Linux.
 
−
# It supports all of the languages we will be using in this class.
 
−
# It has a decent amount tools like auto-completion that will speed up your workflow.
 
  
−
=== Installation ===
+
''Windows:'' You will be running commands on your local machine using '''WSL''' or '''Cygwin''', which you will install in the next section.  You will be connecting to your server via SSH.
  
−
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
+
=== Version Control ===
  
−
=== Connecting Komodo to your Remote Instance ===
+
You will be using '''Git''' as your version control system.  Git enables you to keep track of changes to your source code.  If you're using VS Code, the Git integration makes is very user friendly.
  
−
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.
+
=== Text Editing ===
  
−
==== Adding SSH Public Key to Keychain ====
+
Although we highly recommend '''VS Code''', you may use '''Sublime Text''', '''Komodo Edit''', '''Notepad++''' (for Windows), and '''TextWrangler''' (for Mac). You can also use an IDE, like '''PHPStorm''', if you prefer.
  
−
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.''
+
=== File Transfer ===
  
−
===== Mac OS X =====
+
In order to deploy your projects to your EC2 instance, you need some sort of method to transfer files from your local machine to your instance using SFTP. One option is using '''FileZilla''', an FTP client, to transport files from your local computer to your server.
  
−
# Open Terminal.
+
=== Flowchart ===
−
# Save your ''*.pem'' file to'' ~/.ssh/cse330.pem'':
 
−
#: <source lang="bash">$ mv /path/to/your/cse330.pem ~/.ssh/cse330.pem</source>
 
−
# Run the following command to add the key to your SSH agent:
 
−
#: <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 =====
+
If you are more visual, this flowchart might help:
  
−
'' under construction ''
+
[[File:CSE-330-Workflow.png]]
  
−
==== Configure your Server Settings in Komodo ====
+
The flowchart illustrates 3 methods to copy files to your cloud instance: via your text editor, via an external SFTP client, and by cloning your remote Git repository.  We will be primarily using '''Option 2''' in CSE 330 this semester.
  
−
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.
+
In the flowchart, your ''Git Client'' is SourceTree and your ''Text Editor'' is Komodo.  The ''SFTP Client'' could be FileZilla.
  
−
# Open the Komodo Edit Preferences.  In Windows, this is '''Edit -> Preferences'''; in Mac OS X, this is '''Komodo -> Preferences'''.
+
== Installing a Terminal Emulator ==
−
# In the menu on the left, choose '''Servers'''.
+
{{RequiredInstructions|content=
−
# 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'''.
 
−
# 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.
 
−
#: [[File:Workflow-3.png]]
 
−
# Press '''Add''' to save the server information, and then press '''OK'''.
 
−
# '''IF YOU ARE USING PUBLIC KEY AUTHENTICATION''', you need to perform these additional steps:
 
−
## In the Komodo Edit Preferences, choose '''Environment'''.
 
−
## Find the information about your SSH environment:
 
−
##* '''Mac OS X:'''
 
−
##** Enter the command ''ssh-agent'' in Terminal.  You should see output similar to:
 
−
##**: <code>SSH_AUTH_SOCK=/tmp/ssh-xxxxx/agent.xxxxx; export SSH_AUTH_SOCK;
 
−
##**: SSH_AGENT_PID=xxxxx; export SSH_AGENT_PID;
 
−
##**: echo Agent pid xxxxx;</code>
 
−
##* '''Windows:'''
 
−
##** '' under construction ''
 
−
## Add the following environment variables in Komodo:
 
−
##* '''Name:''' SSH_AUTH_SOCK
 
−
##* '''Name:''' SSH_AGENT_PID
 
−
##: The values for these environment variables should be what you learned earlier in step 2.
 
−
## Press '''OK''' to save your changes.
 
−
# 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.
 
  
−
==== Installing Upload Extension ====
+
Windows is based on a fundamentally different architecture than Linux, meaning that, if you want to run Linux programs on Windows, you'll have to enable or install a special terminal emulator for it. Mac users do not need to install a terminal emulator since MacOs itself is a derivative of Unix, which is an ancestor of Linux.  The Terminal utility is all you need.
  
−
Strangely, Komodo Edit does not come built-in with a mechanism to upload files from your computer to the server.  Fortunately, the community has released an add-on that gives us this feature.
+
=== Windows Subsystem for Linux ===
  
−
# In Komodo, go to '''Tools -> Addons'''.
+
Starting in Windows 10, Windows has the ability to emulate Linux, meaning that you can run Linux commands on Windows, without having to install Cygwin. To enable WSL, follow [https://msdn.microsoft.com/en-us/commandline/wsl/install_guide these instructions]. Once those instructions are complete, you can open a shell by clicking on the Start menu, typing "Bash", then clicking on the entry labeled "Bash on Ubuntu on Windows".
−
# Search for the add-on named ''Uploader''.
 
−
# Download and install it, and restart Komodo.
 
−
# In your Server preferences, create a new server (or rename an existing one) to be identical to your project name, but starting with a star. For example, in my project named ''FileShare'', I would name the server ''*FileShare''. The ''default path'' will be the location to which Komodo will upload your files. '''Note: The path should be absolute.'''
 
−
# You can now select a file and go to '''File -> Upload''' to upload it to your server.
 
  
−
'''Tip:''' To make things quicker, you can bind a keyboard shortcut like ''ctrl/cmd+D'' to the Upload feature by following these steps:
+
=== Cygwin ===
  
−
# In Komodo preferences, choose '''Editor -> Key Bindings'''.
+
'''Cygwin''' is a Linux Terminal emulator for Windows.
−
# Find the "Upload" command under "General".  Press in the "New Key Sequence" box, and press ''ctrl/cmd+D''.  Proceed through the on-screen instructions; you can name your new scheme ''Custom''.
 
−
# Save the preferences and restart Komodo.  You will now be able to upload files by simply pressing ''ctrl/cmd+D''.
 
  
−
== SourceTree ==
+
==== Installation ====
  
−
'''SourceTree''' is a tool that enables you to perform version control using a graphical user interface.  It is free and available for Windows 7+ and Mac OS X 10.6+.
+
The CEC lab machines already have Cygwin installed.  Follow these instructions to get Cygwin up and running on your personal PC.
  
−
SourceTree is available on the Mac App Store. Windows users (and OS X users who don't like the App Store) may install it from http://sourcetreeapp.com/
+
# Run ''setup.exe'' from http://www.cygwin.com/
 +
# Keep the Cygwin directory as the default, ''C:\cygwin''.  Choose a place like ''C:\cygwin\downloads'' to download the installation files.  Choose any download site, although probably one with a .com suffix is best when you're in the US.
 +
# In the "Select Packages" screen, select the following packages:
 +
#* Net -> openssh
 +
#* Net -> openssl
 +
#* Python -> python3 (you will need this for Module 4)
 +
#* Devel -> git (version control system)
 +
#* One or more of the following:
 +
#** Editors -> vim
 +
#** Editors -> emacs
 +
#** Editors -> nano
 +
# Allow the installation to complete.
  
−
=== Git ===
+
Throughout the rest of this course, when we say to "open a terminal", if you are on Windows, we mean to "open WSL/Cygwin".
  
−
'''[[wikipedia:Git (software)|Git]]''' is a ''distributed version control system'' that enables you to track changes to your code and work with collaborators on the same code base.  In CSE 132, you used ''Subversion (SVN)'', which is also version control system.
+
}}
  
−
Git, like SVN, is a command-line tool.  However, SourceTree enables you to use Git without having to pull up a Terminal window every time you need to perform an action.
+
== Github ==
  
−
In Module 5, you will learn more advanced techniques for using Git.  However, for Modules 2-4, you will be using Git primarily as a method to push your changes to your remote repository.
+
{{RequiredInstructions|content=
  
−
=== Configuring Git/SourceTree ===
+
'''Github''' is a service that enables you to store your code for free in the cloud.
  
−
Once you install SourceTree, you need to tell it your name so that it knows how to tag changes you make.
+
=== Creating a Github Account ===
  
−
# Open the SourceTree Preferences (SourceTree->Preferences on OS X or Tools->Preferences on Windows).
+
Go to [https://github.org/ Github.org] to create an account.
−
# Check the box that says "Allow SourceTree to modify your global Mercurial and Git configuration files".
 
−
# Enter your name and e-mail address.
 
  
−
'''Note:''' This actually does the same thing as running <code>git config --global user.name <NAME HERE></code> and <code>git config --global user.email <EMAIL HERE></code> from the command line.
+
'''Important:''' Use your @wustl.edu e-mail address to create your account. This will put your account on the "educational plan", which removes some limitations of the free account.
  
−
=== Cloning a Repository ===
 
  
−
We will start by '''''cloning''''' a remote Git repository.
+
=== Adding Your Key to Github ===
 +
'''Not uploading your key is perfectly fine, and in many cases easier.  Here are the instructions though, if you'd like'''
  
−
"Cloning" in Git is much like "checking out" in SVN: a remote copy of the repository is copied down to a local working directory. '''Word of Caution:''' Git uses the term "checkout" to mean something different (which you will learn in Module 5), so ''do not'' use the words "clone" and "checkout" interchangeably.
+
# First make sure that you've finished the [[SSH]] guide configuration instructions.
 +
#: We will use the same key for connecting to your remote server as for connecting to Github.  (This is completely valid practice.)
 +
# Go to the "SSH keys" section of the settings panel (Manage Account -> SSH Keys)
 +
# Add a new key.
 +
#* I recommend naming it after the computer you're using; if you're in the CEC, for example, you could name it "Warehouse Cygwin".
 +
#* The contents of your key is the contents of your ''id_rsa.pub''.  It looks like <code>ssh-rsa AAAAB3blahblahblahblah yourname@somedomain</code>.  It is exactly the same thing that you had to paste into the ''authorized_keys'' file on your EC2 instance.
  
−
If you wanted to clone a repository on the command line, the command would be:
+
You will now be able to push code to your Github repository using your personal SSH key.
  
−
<source lang="bash">$ git clone git://www.example.com/url-of-repo destination-path</source>
+
}}
  
−
In SourceTree, go to '''File->New''', enter the remote repository URL and the destination path, and press "Clone".  The destination path is where you want the repository's files to be copied on your personal computer; the path should point to either an empty or a nonexistent directory on your personal computer.  In this screenshot, I am cloning the repository for the Fedora Linux kernel:
+
== FileZilla ==
  
−
[[File:SourceTree-Clone.png]]
+
{{RequiredInstructions|content=
  
−
The remote repository will now be cloned onto your personal computer and all ready to use.
+
You can use SFTP from the command line, or you can use any GUI file transfer client.  All FTP clients I have seen also support SFTP.  One popular FTP client is [http://www.filezilla-project.org/ Filezilla].
  
−
== Starting a Project ==
+
# Download and install FileZilla from http://filezilla-project.org/download.php?type=client
 +
#: If you are using a lab computer, you can save it to your H drive.
 +
# When you launch FileZilla, go to Edit→Settings or FileZilla→Preferences, and go to the SFTP options (under Connection).  Click "Add keyfile…".
 +
#* Choose your ''id_rsa'' file.  '''OS X Tip:''' Press Shift+Command+Period to reveal hidden files in the file chooser window.
 +
#* FileZilla will want to make a *.ppk file.  A good place to save it would be the .ssh directory as ''id_rsa.ppk''.
 +
#: When finished, press '''OK''' (not the red ×) to save your changes.
 +
# Back on the main FileZilla screen, there are four fields: Host, Username, Password, and Port.  Fill them in as follows:
 +
#* '''Hostname:''' sftp://<ec2-xxx-xx-xx-xxx.compute-1.amazonaws.com/>
 +
#* '''Username:''' The username you created on your server.
 +
#* '''Password:''' Since you are using a key, you may leave this blank.
 +
#*: If you changed your SSH settings to allow password-based authentication, then you could put your password in here.
 +
#* '''Port:''' 22
 +
# Then click Quickconnect.  If everything is configured correctly, FileZilla should log into your server.
  
−
When you start a new project, whether individual or group, you should create a new directory and a new Komodo Project file.
+
[[File:FileZilla.png]]
  
−
# Create a new directory in your repository named after the project you will be starting (e.g., ''fileshare'').
+
On the left and right of the FileZilla window, you can drag files between your computer and your server.  Thus, you can edit a file in a text editor like Notepad++ on your decktop, and then upload it to your server by simply dragging it from the left pane to the right pane in FileZilla.
−
# In Komodo, choose '''Project -> New Project''' (or press shift-ctrl-N).
 
−
# Navigate to the directory you just created, enter a name for the project (e.g., ''FileShare.komodoproject''), and press "Save".
 
−
# You should now see a window like this:
 
−
#: [[File:Workflow-1.png]]
 
−
# 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 [[HTML and CSS#Quick and Easy Page Layout|Quick and Easy Page Layout]]:
 
−
#: [[File:Workflow-2.png]]
 
−
# 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.
 
−
# When you are ready, upload your files to your remote server.  To do this, go to '''File -> Save as Other -> Remote File'''.
 
  
−
[[Category:Module 2]]
+
}}

Latest revision as of 18:25, 13 September 2024

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.

Overview

There are going to be several aspects to our workflow in CSE 330, and we will be switching between multiple different programs. Here is how they all fit together.

Running Commands

Mac OS X: You will be running commands on your local machine using Terminal, which you can find in your Applications -> Utilities folder. You will be connecting to your server via SSH.

Windows: You will be running commands on your local machine using WSL or Cygwin, which you will install in the next section. You will be connecting to your server via SSH.

Version Control

You will be using Git as your version control system. Git enables you to keep track of changes to your source code. If you're using VS Code, the Git integration makes is very user friendly.

Text Editing

Although we highly recommend VS Code, you may use Sublime Text, Komodo Edit, Notepad++ (for Windows), and TextWrangler (for Mac). You can also use an IDE, like PHPStorm, if you prefer.

File Transfer

In order to deploy your projects to your EC2 instance, you need some sort of method to transfer files from your local machine to your instance using SFTP. One option is using FileZilla, an FTP client, to transport files from your local computer to your server.

Flowchart

If you are more visual, this flowchart might help:

CSE-330-Workflow.png

The flowchart illustrates 3 methods to copy files to your cloud instance: via your text editor, via an external SFTP client, and by cloning your remote Git repository. We will be primarily using Option 2 in CSE 330 this semester.

In the flowchart, your Git Client is SourceTree and your Text Editor is Komodo. The SFTP Client could be FileZilla.

Installing a Terminal Emulator

Windows is based on a fundamentally different architecture than Linux, meaning that, if you want to run Linux programs on Windows, you'll have to enable or install a special terminal emulator for it. Mac users do not need to install a terminal emulator since MacOs itself is a derivative of Unix, which is an ancestor of Linux. The Terminal utility is all you need.

Windows Subsystem for Linux

Starting in Windows 10, Windows has the ability to emulate Linux, meaning that you can run Linux commands on Windows, without having to install Cygwin. To enable WSL, follow these instructions. Once those instructions are complete, you can open a shell by clicking on the Start menu, typing "Bash", then clicking on the entry labeled "Bash on Ubuntu on Windows".

Cygwin

Cygwin is a Linux Terminal emulator for Windows.

Installation

The CEC lab machines already have Cygwin installed. Follow these instructions to get Cygwin up and running on your personal PC.

  1. Run setup.exe from http://www.cygwin.com/
  2. Keep the Cygwin directory as the default, C:\cygwin. Choose a place like C:\cygwin\downloads to download the installation files. Choose any download site, although probably one with a .com suffix is best when you're in the US.
  3. In the "Select Packages" screen, select the following packages:
    • Net -> openssh
    • Net -> openssl
    • Python -> python3 (you will need this for Module 4)
    • Devel -> git (version control system)
    • One or more of the following:
      • Editors -> vim
      • Editors -> emacs
      • Editors -> nano
  4. Allow the installation to complete.

Throughout the rest of this course, when we say to "open a terminal", if you are on Windows, we mean to "open WSL/Cygwin".

Github

Github is a service that enables you to store your code for free in the cloud.

Creating a Github Account

Go to Github.org to create an account.

Important: Use your @wustl.edu e-mail address to create your account. This will put your account on the "educational plan", which removes some limitations of the free account.


Adding Your Key to Github

Not uploading your key is perfectly fine, and in many cases easier. Here are the instructions though, if you'd like

  1. First make sure that you've finished the SSH guide configuration instructions.
    We will use the same key for connecting to your remote server as for connecting to Github. (This is completely valid practice.)
  2. Go to the "SSH keys" section of the settings panel (Manage Account -> SSH Keys)
  3. Add a new key.
    • I recommend naming it after the computer you're using; if you're in the CEC, for example, you could name it "Warehouse Cygwin".
    • The contents of your key is the contents of your id_rsa.pub. It looks like ssh-rsa AAAAB3blahblahblahblah yourname@somedomain. It is exactly the same thing that you had to paste into the authorized_keys file on your EC2 instance.

You will now be able to push code to your Github repository using your personal SSH key.

FileZilla

You can use SFTP from the command line, or you can use any GUI file transfer client. All FTP clients I have seen also support SFTP. One popular FTP client is Filezilla.

  1. Download and install FileZilla from http://filezilla-project.org/download.php?type=client
    If you are using a lab computer, you can save it to your H drive.
  2. When you launch FileZilla, go to Edit→Settings or FileZilla→Preferences, and go to the SFTP options (under Connection). Click "Add keyfile…".
    • Choose your id_rsa file. OS X Tip: Press Shift+Command+Period to reveal hidden files in the file chooser window.
    • FileZilla will want to make a *.ppk file. A good place to save it would be the .ssh directory as id_rsa.ppk.
    When finished, press OK (not the red ×) to save your changes.
  3. Back on the main FileZilla screen, there are four fields: Host, Username, Password, and Port. Fill them in as follows:
    • Hostname: sftp://<ec2-xxx-xx-xx-xxx.compute-1.amazonaws.com/>
    • Username: The username you created on your server.
    • Password: Since you are using a key, you may leave this blank.
      If you changed your SSH settings to allow password-based authentication, then you could put your password in here.
    • Port: 22
  4. Then click Quickconnect. If everything is configured correctly, FileZilla should log into your server.

FileZilla.png

On the left and right of the FileZilla window, you can drag files between your computer and your server. Thus, you can edit a file in a text editor like Notepad++ on your decktop, and then upload it to your server by simply dragging it from the left pane to the right pane in FileZilla.

Retrieved from "http://classes.engineering.wustl.edu/cse330/index.php?title=Workflow&oldid=2929"