Skip to content

AustinCodingAcademy/javascript-workbook

Repository files navigation

CircleCI

Austin Coding Academy

JavaScript Workbook

Claiming your workbook

  1. Click the 'Fork' button (choose your account if prompted).
  2. Copy HTTPS URL from your forked repository
  3. In your terminal (or in git bash, for Windows people), navigate (using cd) into a directory where you want to start keeping your repositories.
  4. Clone your new repository by typing git clone <forked clone URL> (the HTTPS URL you copied above) Forking a repository
  5. Now go into the new directory by using cd javascript-workbook
  6. Add the base repository as an upstream git remote add upstream https://github.com/AustinCodingAcademy/javascript-workbook.git
  7. Check the configuration of your remotes with git remote -v, it should look very similar to this (except it'll be YOUR username)
$ git remote -v

origin  [email protected]:username/javascript-workbook.git (fetch)
origin  [email protected]:username/javascript-workbook.git (push)
upstream    [email protected]:AustinCodingAcademy/javascript-workbook.git (fetch)
upstream    [email protected]:AustinCodingAcademy/javascript-workbook.git (push)

Push to Github and create a PR

  1. From your project directory, run npm install to tell NPM to install all the node modules we use in this class

  2. Use Atom (or another editor) to make the change to the index.html file in the top level directory. Change Hello World! to Hello <your name>!

  3. When you're finished, stage your file, commit your changes, and push to GitHub using the following commands:

    git status
    git add .
    git commit -m "Initial Commit"
    git push origin gh-pages
  4. Now go to your forked repository on GitHub (at https://github.com/your-username/javascript-workbook). A little yellow box should have popped up asking you to make a Pull Request. Click to review.

  5. Click "Create Pull Request"

  6. Every time you make a change and push to GitHub, this PR will automatically update. No need to do it more than once.

Get latest workbook updates

  1. To get the latest code/homework/test updates, be sure to have a "clean working directory" by committing or removing all of your changes. You check for a "clean working environment" by running git status and making sure no files show up.

  2. Run git pull upstream gh-pages

Contributing workflow

Running the apps

Simply run node path/to/file.js

example node 01week/rockPaperScissors.js

Running Tests

Tests are a great way to make sure you code works the way you planned it would, and to make sure you don't break something in the future. We will be using them to test our understanding of the lesson. It's also our main way to assign grades for an assignment.

To run a the tests on a file run npm test path/to/file.js, etc.

Running the Linter

Simply run npm run lint

Running the Server

  1. Run npm start
  2. To break out of the server, press ctrl + c