Admin Manual
User Manual:
Open the PDF directly: View PDF 
.
Page Count: 3
Administration manual
When taking over this program a number of accounts, programs and dependencies have to be set
up. This manual will go through the different steps to be able to host, run and further develop the
program. In short, a Github account, Heroku and Circle CI account has to be made to maintain the
app. Furthermore, for all functions and test environment of the TicTacToe app to work Node.js,
Npm and Heroku have to be installed locally.
GitHub
To get access to the project on your own computer you can use Terminal for Mac and Linux or
Command Promt/Git Bash for windows. Go to the directory where you want to store the project
and type in the following command:
$ git clone https://github.com/Club15/TicTacToe.git
List of common git commands:
Creates and moves you to a new branch.
$ git checkout -b <Name of branch>
shows which files have been updated since the last pull.
$ git status
First step of adding the new changes to GitHub.
$ git add <Name of file>
Second step is to commit the changes to the local repoitory.
$ git commit -m ”Good explanation of what was changed ”
Third step is to push the changes to the master branch
$ git push: Updates the changes to GitHub.
Gets the newest updates of code from GitHub.
$ git pull
Node and NPM
In order to run the program for development or debugging one has set up Node.js and NPM.
Node.js is among other used as a package manager. NPM is used to get additional libraries and
manage functional dependencies for the program. Additionally Node.js sets up Javascript runtime
to be able to run the code outside of a browser.
Setup:
Download Node.js here: https://nodejs.org/en/
Run the installer and verify installation by typing
$ node --version
NPM is distributed with Node.js and should therefore be installed as well.
Verify installation by typing
$ npm --version
After installation and pulling the newest version of TicTacToe from the Git repository to initialize
the development environment traverse to the root folder of the program and run the command
$ npm install
The command npm install will download and install the dependencies for the program such as
Express (https://expressjs.com/) and Lodash (https://lodash.com/) and development
dependencies such as Jest (https://jestjs.io/), Supertest
(https://www.npmjs.com/package/supertest), Webpack (https://webpack.js.org/) and Puppeteer
(https://github.com/GoogleChrome/puppeteer). Further information about which dependencies
are used can be seen in the package.json file and the commands for the environment can be
found under scripts.
Most notable of the script commands are:
To start both the node server and the webpack development server.
$ npm run startapp
To only run the webpack development server.
$ npm run server
To remove all dependencies and delete the /node_modules folder.
$ npm run clean
Heroku
Heroku is a cloud platform as a service that is used to deploy the app so it is accessible outside
the working directory. The TicTacToe game can be found on the website
https://gameclub15.herokuapp.com/.
Heroku is installed as a dependency when the when the command npm install is ran.
To confirm that the installation was a success type in the following command
$ heroku --version
Next you have to log in to Heroku through your terminal using
$ heroku login
The last step is connecting to the app gameClub15
$ git remote add heroku git@heroku.com:gameclub15.git
You can check if the connection was a success with this command:
$ git remote -v
Heroku has been set up to deploy automatically after each push to the master branch on git as
long as Circle Ci gives a pass on the new code. If for some reason that needs to be changed you
can go to https://www.heroku.com, select the app gameclub15, go to deploy, and there you can
find Automatic Deploy and press the button Disable Automatic Deploy.
To get an overview of the build history click here
(https://dashboard.heroku.com/apps/gameclub15).
If you need to maintain the app you can also select settings and turn on Maintenance mode.
Circle CI
Circle CI is an continuous integration program. It runs test on TicTacToe when a new version is
pushed on Github. In the .circleci folder is a file config.yml that tells Circle CI what test to run
and what it needs to install to run the test. Circle CI is connected to Github and users can see if
the version that is pushed passes all the test or not. It is also possible to see details of the test and
what went wrong on Circle CI webpage (https://circleci.com/gh/Club15/TicTacToe).
To be able to use Circle Ci, the user needs to sign up on their webpage with the Github account
that has access to TicTacToe.
