Skip to content

Latest commit

 

History

History
177 lines (101 loc) · 16.9 KB

README.md

File metadata and controls

177 lines (101 loc) · 16.9 KB

Building a Tic-Tac-Toe application with React

This is a tutorial for building a Tic-Tac-Toe game with React, Redux, redux-observable, Rx.js, and more. We'll start simply, and continue building on the app, step by step, until we've created something quite powerful. Note: this is still a work in progress. YMMV.

Each step of the tutorial is in a different git branch. We could have used tagged commits, but it's easier to go back and update branches as we discover typos and other errors. So branches it is.

To start the tutorial, begin with the 00-set-up branch. Read the README file and follow the instructions carefully. It will be easier to read it online. When you complete that step, move on to the next branch (step), and then the next, and so on. Here are direct links to the branches for each step. The instructions for each step are in the README for that branch, and the code in that branch shows the completion of that step:

  1. Set up
  2. Add the game board
  3. Add snapshots
  4. Add click-handler and player
  5. Add state management

The code in each branch represents the state of the code after completing the instructions in the README for that branch. This is so that you can reference the completed code if you get lost.

There are a few drawbacks to this simple approach, but it works for now. Eventually, we'll move this tutorial to an actual learning management system, which will make it much easier to use.

There are three options for how to complete this tutorial.

Option 1: Real world

The first option is to follow all the steps in the Set up branch README, working on your own machine. This will involve having a browser, terminal app, code editor or IDE, as well as having git, node, npm or, preferably, yarn, and more installed on your machine. Often people get hung up in this set up phase, but if at all possible, it's best to get things working on your own machine.

**If you are coming to a class where we use this tutorial, make sure you complete the set up step successfully before the class starts, or use another option below.

If you get stuck at any time throughout the tutorial, you can always switch to one of the other two options below.

Option 2: Real world with help

In this option, you still work on your own machine, which means having a browser, terminal app, code editor or IDE, and git, etc. installed, but you only go as far as setting up your machine. Once you have the right software installed, you clone this repo and then checkout the 00-set-up branch and go from there (starting with the 01-add-the-game-board branch README, which you can read from the GitHub repo page).

If you use this method, create your own branch to work in. Here's how you do that. First, clone the repository. From your working directory in the terminal app:

git clone [email protected]:test-er-8-or/tic-tac-toe.git && cd tic-tac-toe

Or, if you prefer,

git clone https://github.com/test-er-8-or/tic-tac-toe.git && cd tic-tac-toe

Then, check out the first branch and create your own branch from it:

git checkout 00-set-up
git checkout -b step-01

Remember, the 00-set-up branch code is the code after the instructions in the 00-set-up branch README are completed. So if you branch off of 00-set-up, you are ready to start Step 1: Add the game board.

Now you can just follow along in the code.

What happens if I get stuck?

If you get stuck and can't make one step (branch) work, then you can simply check out the branch whose instructions you were trying to complete, but which didn't quite work out for you, and then create a new branch off of that.

Note again: The code in each branch represents the completion of the instructions in that branch's README, not the starting point for those instructions, which was the end of the last step.

So, suppose that you'd finished the instructions for Step 1, but that it didn't work. You're tired of debugging with no joy, and you just want to move on.

Then stop, commit your changes, check out the branch you were trying to complete from your cloned repository, and make a new branch from that. You were stuck on Step 1, so you check out the 01-add-the-game-board branch, and create a step-02 branch from that:

git checkout 01-add-the-game-board
git checkout -b step-02

Now you've got code that represents the completion of Step 1 and should work. You're ready to start Step 2. Repeat as needed.

Reminder: you created a branch from Step 1 so that you can do the instructions in Step 2.

Option 3: Do it online with CodeSandbox

The other option is to jump to the next step in CodeSandbox and fork from it. Click on an option below to see:

You can fork any of these online and then save your work. If you log in with GitHub, you get special super powers (try it and see). These are pulled directly from this repository, so if you see a little "Update available" yellow arrow in the upper right hand corner of the interface, click it to load the lastest code. Nice!

We strongly recommend working with the real-world tools—GitHub, Visual Studio Code, iTerm2 or equivalent, etc.—but if you can't get them set up, go ahead and use the CodeSandbox.

How to get the most out of this tutorial

This tutorial uses a modern method of learning called "Just-in-time learning" (JITL). The idea behind JITL is to learn only what you need to know, precisely when you need to know it, and to apply it immediately.

This is very different from the way you have learned in the past, and it may take some getting used to. Virtually all the instruction you've had in your life so far will most likely have been what we call "Just-in-case learning" (JICL). Just-in-case learning means expending time, energy, and money learning things that you may never need, or won't need in the foreseeable future, because, well, just in case.

This is a tremendous waste, and it often exhausts novices because they don't know where to put their effort for the maximal return. They tend to take a shotgun approach, trying to learn a little bit of everything, and learning nothing very well. Often, they quit in frustration.

There are several other tools from the Munat Methodology in use here. Let's discuss a few:

Learn inductively not deductively

Begin with concrete examples, then abstract the principles, not the other way around. Stay as low on the tree of abstraction as you can.

In this tutorial, we show you the code first, even though you may have no clue what it means or how it works. Type it into your own project (or copy and paste, but typing it will help you to learn it more rapidly) and see how it works. Once you see how it works, then we'll explain it, but only what you really need to know.

Learn outside-in

Begin with the context and framework so you know where you are going, then fill in the detail.

Rather than learn a lot of little bits of code that eventually, someday, if you stick with it, might add up to a web application, we begin by generating the basic application right up front. Now you can see where we're going. Then we modify it little by little until it becomes the final product. We don't waste time explaining variables, loops, conditionals, etc.—these will become clear with regular use, and, after you've seen them a few times, we'll take a moment to point them out to you.

This means you're always oriented as to where you are and where you want to go, even if you don't understand any of the details just yet. Be patient. We'll get there.

Favour skills over knowledge

Skills require mentoring and practice, and practice makes permanent. Do it right the first time and every time. Knowledge is perishable and volatile and can be acquired instantly and the moment it is needed. Hello, Google!

The key to this tutorial is repetition. Go through it the first time just following along and typing (or copying and pasting) the code and getting an idea of what's involved and how it works, generally. Don't try to understand everything! Don't worry that you don't understand everything (no one does)! Just get through the tutorial and make it work.

Then go through it from scratch a second time. This time, take a bit more time to examine the code. Try to understand not only what we did, but how we did it. What do all these funny words really mean? They are not that hard to figure out—as long as you don't go down rabbit holes.

What do I mean by that? Take this line of code:

import { map } from 'ramda'

What does that mean? Well, even if you've never done any programming before, you probably know that "import" means to bring something in from outside, for example, importing furniture from Scandinavia (unless you're already in Scandinavia, in which case it's importing coffee from Ethiopia). So 'ramda' must be something outside our code (in fact, it's a library of code we're borrowing functions from), and "map" must be something we'll need that isn't already available to us, so we have to go get it from somewhere else. That much you can probably suss out just from the syntax above.

But how does this really work?

WHO CARES?

This is the realisation that will help you the most out of this tutorial: Don't dig any deeper than you need to! Think James Bond: we're operating on a need to know basis, and you ain't got it . . . yet.

It's enough to know that you're importing something called "map" from something called "ramda". Elsewhere, we've given you a link to the Ramda documentation that you can use when you need to know how that works. But that's not now, the first time you see this. So don't go running off to figure out what it means! Just leave it.

Will you need to know how imports work, and how importing from a library such as Ramda differs from importing from your own JS files? Yes, of course you will. But not right now! So let it go. Catch it on the second pass, or the third, or maybe never if it turns out you can get the job done without having to know it.

This is the part of Just-in time learning that is so difficult for most of us. We've spent our entire lives believing that we have to memorise all sorts of things in order to be truly knowledgeable. That might have been true 50 years ago, but today it's demonstrably false! Almost everything you're going to learn in this tutorial will be obsolete in a year or two, if not in a few months or weeks! Every thing you memorise or learn that you don't need in that period is time, energy, and money wasted (note: time === money). So just don't do it!

The key to learning skills, such as programming, is repetition. If you need to remember something, it will be because you need to use it all the time, and if you use something all the time, then you will automatically memorise it by repetition. So no need to work at it. Just do the tutorial repeatedly, learning a bit more each time, and forget about memorising things.

Make notes of things you might want to look up later as you go along. Then don't look them up until you have to. You may be surprised to find that you end up tossing out your notes never having bothered to look up even one thing from them.

Follow the single, shortest path

Pick one good way to do the thing and stick to it. Providing alternatives early on only confuses and increases cognitive load. There will be time to learn other approaches later.

There are a thousand ways you could build this Tic-Tac-Toe app. Is this the best way? Who cares? It's a good enough way. I promise you that this method is pretty close to current state-of-the-art as of the latest commit. If you ask fifty React developers if this is the best way to do this, you'll get fifty different answers, but mostly that's just bikeshedding. This method is good enough. Follow these instructions and keep repeating until you have them down cold.

Then you can try a slightly different approach. And then another. Vary it a bit this way or that. Try it with a different framework. Over time, you'll find what you like and you'll change your code accordingly. And that's as it should be. But right now, when you're first learning i, just do it one way. In short, either follow these instructions precisely, or choose a different tutorial. Don't try to diverge from the instructions until you're sure you understand them.

The fifth-dan black belt can create her own style. The yellow-belt beginner who attempts this will only make a fool of himself. Follow the single, shortest path to the goal. Repeat until you know it blindfolded. Then seek nearby paths and continue this process until you can travel at will.

"But some choice you made is wrong!"

This tutorial is an experiment with a new methodology for learning—really, a combination of many well-known, but often ignored, methods for learning. As such, it uses a very specific pedagogy. You may not like this approach. You may even hate this approach. If that is the case, then I happily urge you to write your own tutorial following your own pedagogy. Hell, write a book about it. I am.

But don't ask me to change this approach or rewrite this the way you'd prefer it. I didn't happen upon this approach by accident; neither did I just throw together a few techniques that sounded good. I've spent more than twenty years experimenting with and honing this pedagogy. I'm not likely to abandon it or change it on a whim, and certainly not on your whim.

But that doesn't mean that I'm not open to criticism or new ideas! I'm just not interested in gratuitous ones. If something really doesn't seem to work, and you think you know a better way, then by all means ask questions about it or suggest an alternative. I'm happy to learn new things. The goal here is not to do things my way, but to do the the best way I can discover. But please, try this way before you rush to suggest another. You may be surprised.

Also, bear in mind that I'm working with a large and diverse group of learners. What works for you, might not work as well for others. Ideally, all learning would be made-to-measure (another of the Munat Methods), but with an online tutorial such as this, that's simply not possible. Yet. I'm working on some ideas. So this is a shot fired at centre of mass.

To be clear: By putting this online and inviting you to take part in it, subject to the understanding above, I am creating a social contract with you. That means that I have a responsibility to make sure this is an effective use of your time. Anything else is simply disrespectful. I take that responsibility very seriously, so if something is really wrong, or simply does not work (within reason), then please let me know and I'll fix it ASAP. I hope you find this tutorial as effective and efficient as I've intended it to be. In short, I've tried to write the tutorial that I wish I had had available to me when I was first learning JavaScript and React.

So have fun! Go forth and learn.

Start with the set up

  1. Set up
  2. Add the game board
  3. Add snapshots
  4. Add click-handler and player
  5. Add state management

With more to come soon.