This is what you'll be building:
Hello, welcome! This is the "Build your own Serverless tic tac toe AI using Node.js and (a little bit of) TensorFlow.js" Workshop. I hope you are in the right place!
First off let's introduce ourselves:
Hew - Software Engineer at Applied
Thomas - Software Engineer at BAE Systems
Over the next 2.5 hours, we will help you learn about serverless functions, good use cases of them, and bad ones! We will also show you how easy it is to build, test, and deploy them.
If you need any help with the prerequisites send either of us a message and we will try help out.
- 1 laptop
- node.js and git installed.
- 1 GitHub account
- Some basic Javascript knowledge
- Over 9000 patience for silliness
Our goal is to help you get a basic understanding of Serverless, otherwise known as Functions As A Service. We hope to do this by working through an examples together for a use case that doesnt really make sense but Hew it made work anyway (what a hero).
The application is made in Vue.JS it's an aproachable and blazing fast framework for building applications in JavaScript. A little bit of javascript is all you will need to get through the workshop, but if you want to learn more have a look through the documentation. Its fantastic!
We will be deploying the application to Netlify it's a great platform for hosting and deploying websites and it links together very nicely with source control. Best of all it is free for small projects like this. We totaly did not get paid to say this but @netlify if you are listening? ;)
We will also use netlify functions, these are a quick easy way to deploy a serverless function to AWS.
-
Building a serverless function that responds with the best next move. (We have some helpful code snippets to help with this one, if you have any suggestions to improve them let us know)
-
Write an api test that checks the function works as intended.
-
Wire up the function to the front end and enable AI mode!
-
Create a test that checks switching between AI and PVP works.
The following steps will get you up and running.
- Fork your own copy of the lnug/CityJS-Workshop-Starter to your account.
- Go to Netlify and sign up.
- Click New Site from Git.
- Pick the CityJS-Workshop repository and Click Deploy.
Also
- Clone a local copy of the repository
- Run the application with
yarn serve
Netlify is a super easy platform for building, deploying, and serving sweet modern web apps. It'll host a single page app statically and serve up the backend as serverless functions - super scalable, super cheap and super great.
The netlify.toml file describes how the site should be deployed
[Settings]
ID = "Your_Site_ID"
[build]
base = ""
publish = "dist"
functions = "functions/"
command = "yarn build"
The base directory is the starting point where netlify looks for a file that shows how your project is configured. i.e. a package.json. It will also install any dependencies for you. All files in the publish directory get deployed to netlifys CDN.
All js files in the funcion directory get deployed as an aws lamda accessable on /.netlify/<name_of_folder>/<name_of_file>
Netlify also lets us have a build step. This helps keep the repo free of any bundled and minified code and also allows us to run any preprocing steps on the source code before it gets deployed.
The build command yarn build runs this command
netlify-lambda build src_functions && vue-cli-service build
The netlify-lambda and vue cli hide the nuts and bolts from us but behind the scenes they are using webpack and babel + lots of plugins 🌄 to make our code run better once its deployed
- netlify-lambda - This takes the contents of src_functions. Compiles, and Minifies it. Then puts the output in the functions directory specified in the netlify.toml
- vue-cli-service - This builds your vue templates into browser parsable html, css and javascript. Then puts it into the dist directory.
To start with the app works as a 2 player Tic Tac Toe game, all the functionality is in the frontend.
To start the application run yarn serve. This runs both the frontend and backend in development mode.
Netlify deploys the functions to <your_site>/.netlify/functions/<function_name_here> but in development they run on http://localhost:9000/<function_name_here>
So that the development experience is seemless the vue development serve proxies the requests to that location using this config:
// vue.config.js
module.exports = {
devServer: {
proxy: {
'^/.netlify/functions': {
target: 'http://localhost:9000',
changeOrigin: true,
pathRewrite: {
'^/.netlify/functions': '',
},
}
}
}
}If at any point things stop working and you dont know why, rerun the yarn serve command. If you need help just ask us and hopefully we will do our best to help fix it!
Endpoints are built from the src_functions directory. Make a new file in src_functions with touch test.js. Netlify will process this into an endpoint called /test and calling the endpoint will trigger the function.
So
// src_functions/test.js
exports.handler = function(event, context, callback) {
console.log('hello world')
}Will log 'hello world' to the console every time the endpoint is hit. It'll also not return anything and timeout so... not great.
Instead we need to provide a proper callback and return a nice response. The function below will log out the string and return a 200 with the text as well.
// src_function/test.js
exports.handler = function(event, context, callback) {
console.log('hello world')
callback(null, {
statusCode: 200,
body: "Hello, World"
});
}Want to take input from a post request and do stuff in the function? Easy
// src_function/test.js
exports.handler = function(event, context, callback) {
// If you are building something serious you should probably
// validate that request type :D
if (event.httpMethod !== "POST") {
return { statusCode: 405, body: "Method Not Allowed" };
}
const string = event.body
callback(null, {
statusCode: 200,
body: `Hello, ${string}`
});
}The frontend stores the board as an array of length 9: 0 denotes an empty field 1 is an 'x' -1 is an 'o'
So the board:
would be represented by the array
[0, 1, 0, 1, -1, -1, 0, 0, -1]
So... lets try to make the endpoint take the board and return the 'next move'. Lets start with just playing the move in the first available space on the board.
So for [0, 1, 0, 1, -1, -1, 0, 0, -1] we want to return 0 (the first empty board position)
So we're going to use brain.js for our neural net. Why? It's simple.
To train your net you just pass in the training data to the net.train() function. The training data needs to be of the form:
[{input: [], output: []}, {input: [], output: []}, {input: [], output: []}, ...]
We have a couple of options for training data. This super-useful resource from Connelly Barnes gives us some: http://www.connellybarnes.com/work/class/2016/deep_learning_graphics/proj1/
There are 2 data sets: Single label intermediate boards of optimal plays Multi label intermediate boards of optimal plays
Process it into something the neural net can actually use and... give it a go. Brain.js lets us output the model as JSON or function. Functions are cool so lets save the trained model as a function into a separate js file we can use.
const net = new brain.NeuralNetwork(config);
net.train(betterData);
fs.writeFileSync('trained-net.js', `export default ${ net.toFunction().toString() };`);
Using the trained neural net build the neural net endpoint.
Import it import trainedNet from './neuralNet/trained-net'
and then call it const result = trainedNet(board). This will return a value of the shape of the outputs you put into it. So we can now turn our endpoint that gave us a fake 'next move' into a more useful one...
Wiring up the application takes 2 things. You might have noticed that the mode switch button does not actually do anythng.
To implement this we need to done some Vue.js if you havent done this before the steps here should guide you through it.
First we need to make the app toggle between 2 player mode and AI mode. This doesnt work at the moment because there are a few things missing from one of the vue components.
Adding this functionality will introduce us to 2 concepts in vue.
- Emmitting Events
- Passing data to components
// src/components/SplitButton.js
<template>
<div :class="$style.wrap" @click=handleClick>
<div...The @click handler was missing so the method to change the mode was never being called. It binds the handleClick method to the @click event emitted from the element.
Still the button does not change to active when we click on it. We need to bind the :mode prop passed to the component.
line 13 -> [$style.inactive]: mode === 'ai'
Like other SPA frameworks vue passes data up and down the component tree. So we need to add this.$emit('gameMode' to the SplitButton component and make it call a method in the App.vue component.
// src/App.vue line 45
<SplitButton :mode="mode" @gameMode="modeSwitch"/>
// line 90
},
modeSwitch() {
this.resetGame()
this.mode = this.mode === "2Player" ? "ai" : "2Player";
},
resetGame() {@gameMode="modeSwitch" binds the event emitted from the component to the modeSwitch method in the App.vue component.
:mode="mode" passes the mode data into the SplitButton component.
The rest of the AI mode implementation goes in src/components/Grid.vue
If you need a spoiler check here
handleClick: function(position) {
if (this.locked) {
return;
}
if (!this.board[position]) {
this.board = this.board.map((el, index) => index === position ? this.turn : el);
if (this.mode === 'ai') {
this.$emit("toggleLock");
if(this.win()) {
return
}
this.$emit("turnSwitch");
moves.getAIMove(this.board)
.then(response => {
const position = response.data.index
this.board = this.board.map((el, index) => index === position ? this.turn : el)
if(this.win()) {
return
}
this.$emit("turnSwitch");
this.$emit("toggleLock");
})
return
}
if(this.win()) {
return
}
this.$emit("turnSwitch");
}
},