3. GitHub¶
This chapter will show you how to get a git
code repository up and running.
3.1. Create a code directory¶
First things first. It always helps to store all your code in the same place, rather than scattering your work in haphazard folders around your computer.
Let’s settle the issue on the command-line. Open the terminal of your choice. It will start you off in your computer’s home directory, much like your file explorer.
Verify that by using a command called pwd
, which stands for present working directory. The output is the full path of your terminal’s current location in the file system. You should get back something like /Users/palewire/
.
pwd
Enter the ls
command to see all of the home folder’s subdirectories. The terminal should print out the same list of folders you can see via the file explorer.
ls
Use the mkdir
command to create a new directory in the same style as the Desktop, Documents and Downloads folders included by most operating systems.
Since we want it to store our code, we will name this folder Code
.
mkdir Code
To verify the command works, open the file explorer and navigate to your home folder. After it’s run, you should see the new directory alongside the rest.
Now jump into the new directory with the cd
command, which operates the same as double clicking on a folder in your file explorer.
cd Code
In this simple exercise you’ve learned some of the most important, and most common, terminal commands.
3.2. Create a repository¶
Visit GitHub and find the homepage for baker-example-page-template
repository published the Los Angeles Times’s datadesk
account. It can be found at github.com/datadesk/baker-example-page-template.
This is a special kind of repository known as a template. It’s designed to serve as a starting point for new projects. Click the green “use this template” button near the middle of the page to get started.
On the next page, fill in a name for your copy of the repository. You can pick anything. Our example will use my-first-visual-story
.
3.3. Clone the repository¶
Return to your terminal. Use gh
to login to GitHub, which will verify that your computer has permission to access and edit the repositories owned by your account.
gh auth login
After you authenticate, clone the new repository we created. Edit the code below by inserting your user name and repository. Then run it.
gh repo clone <your-username>/<your-repo>
Note
In my case, the command looks like this:
gh repo clone palewire/my-first-visual-story
After clone completes, run the ls
command again. You should see a new folder created by gh
.
ls
Use cd
to move into the directory, where we can begin work.
cd my-first-visual-story
We’ve got our starter kit installed. Let’s get it going.