Skip to content

Latest commit

 

History

History
129 lines (81 loc) · 5.2 KB

1-use-git.md

File metadata and controls

129 lines (81 loc) · 5.2 KB

Website structure, git and GitHub

First, hope you had a good week navigating the command line. We will do a quick review, talk a bit about file structure, and dive into the git/GitHub workflow.

File structure talk ensues. You can find the full text at the end of document.

Git. On. It.

For an open project where no senstive information is involved, what GitHub offers -- as infrastructure -- is fab. Free space is not the main advantage we have here, because, y'know, there's something called digital storage that comes with your ID card here.

Here's my for question for y'all in the room: who can tell me why we might favor GitHub over digital storage?

Enough talk

Now let's put that ongoing construction of your building onto GitHub.

Remote

Create a repo in GitHub*

If you want to do the same in command line:

curl -u USERNAME https://api.github.com/user/repos -d '{ "name": "REPO" }'

Local

Double check: brew and hub installed. If not, do this.

If you do not have a directory on your local machine:

# make sure you know where you are in your system and pick a place for your project. Use one of the commands below

git clone NAME_OF_YOUR_REPO

# or

git clone https://github.com/USERNAME/NAME_OF_YOUR_REPO.git

# navigate to the directory

If you already have a directory:

# navigate to the directory

git init

# optional, check what this is doing

ls -a

# add a remote

git remote add origin https://github.com/USERNAME/NAME_OF_YOUR_REPO.git

# check what this is doing

git remote -v

After you have created and edited your files

  1. git status -- what do you see?
  2. git add filename.extension (if you are committing for the first time) or git add -p if you are modifying an existing file
  • check: git status -- what do you see now?
  1. git commit -m "YOUR COMMIT MESSAGE" -- what does it say in the command line?
  2. git push origin master -- Congrats! Now you can access your content from any computer, and other people can collaborate with you easily.

Make life easier

There're a few git configuration you can do to make life easier.

  1. More colors! If you don't have colors in your iTerm, try this:
git config --global color.ui true
  1. No more password-typing! A world where you type the username and passwords only once is just so much better. To achieve that for your workflow:
  • Follow the steps here
  • Then here
  • Note: the above are from the GitHub help pages. If you don't know what you are doing, it's totally fine. The important thing is that you do it. If you run into problems, send me a screenshot of your iTerm and post an issue. I'll help you out.

Set up your ssh

ssh-keygen -t rsa -b 4096 -C "[email protected]"

Follow the GitHub instruction.

And paste it in your GitHub account.

More on file strcuture

path/to/your/file.thing

  path
    - to
      - your
        - file.thing

  path
    - into the wilderness
    - to
      - airport
      - your
        - file.thing
        - rando
          - hi

Why???

When you are constructing a web page, you might put all your code (html, css, js) in one file which you've learned to create: index.html.

But as soon as you have other assets (photos, logos, videos, and later, if you dream big and you should, assortment of datasets) the one index.html file would no longer suffice -- or, if you will, sustain as the site grows. So one file breaks into pieces -- css gets its own folder, js its own. Your html might be modulized, etc. For larger newspapers, pretty crazy infrastructure has to happen (such as compiling different sections of an html, to say the least) just to produce a page that you can make from ground up. Those processes will come later, and really depends on the organization involved (or if there's an organization at all.)

But for now, think of all the files you put in your site folder as a brick. Since what you are trying to accomplish is to complete the whole building, getting to the right place where you can install a proper window frame is part of the building process.

Too much metaphor? Here's the take-away: Know the skeleton of your building. Follow the current construction convention (i.e. which folder goes where). Know where to look when adding a piece to the building. What happens when the building is finally done? It will be served somewhere. On the internet, how crazy. We'll talk about web servers in the future, but in case you are curious, check out this little snippet on path translation (Indeed, you are learning how the internet works!)