An implementation of the traditional chinese game Go, required for a SENG course.
install Node> 6.2
- Ensure the correct version of node is on your path if you have previously installed node
Install Chrome > 52.0
Install Gulp CLI
In Chrome Canary (52) install Live Reload Chrome Plugin (hot-reload browser side)
Navigate to the project directory
npm install
##Starting the app
npm start
or gulp
The code will be pre-processed and run by gulp.
Navigate to localhost:3000
Click the livereload browser plugin icon to enable live reload of client code
Any changes (frontend,backend) will be instantly reflected upon save in the browser.
Notes :
- Changing core folder names will require you to change the patterns in the gulpfile for code refresh to work.
Start the app
Load the app.
Turn on the live-reload plugin
The page should refresh appropiately in all cases
- Change the color of the
<p>
object to blue insrc/sass/index.scss
- Change the output of
console.info()
insrc/scripts/frontend/index.js
- Change the port in
src/scripts/backend/server.js
- Add a new file to the source. Make it do something.
npm test
will run all tests in thebackend
folder in thetests
foldernpm run test-client
will run all frontend tests- More info on tests can be found in the TESTING.md documents in the
tests
folder
- More info on tests can be found in the TESTING.md documents in the
npm run example-test
will run the example test suitetests\example.js
. See implementation for details
Mocha tests can be debugged in VS code. Their is a debugger set up already to run frontend and backend tests.
- see
packages.md
Debugging with vs code's great debugger is setup. launch.json
will debug the project\
Their are 6 global functions that log to different levels using winston
error()
warn()
info()
verbose()
debug()
silly()
console.log()
has also been overwritten to log with info()
Please use console.info()
, console.error()
, etc