README.md

COMP 361 Project

See also my video instuctions in the screencasts section on MyCourses.

The Rules

• Feel free to edit/replace this file.
• Do not delete or rename the reports, client, server or docs directories.
  See Static Content
• Don't clutter your repo, update your .gitignore file, depending on your client language / technology.
  • Don't commit binaries. (Images, jar files, class files, etc...)
  • Don't commit buffer files. (Vim buffer files, IDE meta files etc...)
• Place your documentation in docs on master.
• Commit frequently, commit fine grained.
• Use branches
• Don't push on master!
  • Create a new branch for your feature.
  • Work until stable / tested.
  • Merge / rebase your temporary branch back to master.
  • Delete your temporary branch.

Static content

• .gitignore: Preliminary git exclusion instructions. Visit Toptal's generator to update.
• reports: Base directory for automatic report collection. Your weekly reports go here. Must be uploaded every monday noon to master and follow correct date string YYYY-MM-DD.md. Use template for your own reports. Do not resubmit same report / copy paste.
• docs: source directory for your enabled GitHub Pages. (Update number in link). Configure IDE to generate API docs into this directory or build your own webpage (optional).
• client: Place your client sources into this directory. Do not use a separate repository for your work.
• server: Place your Spring Boot Game Server sources in this directory. Do not use a separate repository for your work.

Useful Links

Code Style and Tools

• Chrome MarkDown Plugin.
  • Don't forget to enable file:// in advanced settings.
• IntelliJ Checkstyle Plugin.
  • Don't forget to enable Google's Checkstyle Configuration.
• Git CheatSheet.
• Advanced Rest Client (Rest Call Code Generator).

Requirements

• Lobby Service
  • Install Guide
    Recommended: Startup in dev profile (default).
  • API Doc and ARC Configurations
  • Game Developer Instructions
• BGP sample deployment configuration (This one is meant for testing / understanding the interaction between LS, UI and sample game)
  Board Game Platform (BGP) = Lobby Service + Lobby Service Web UI + Sample Game, all as docker containers.
  • Sample Lobby Service Web UI
  • Sample Lobby Service compatible Game (Tic Tac Toe, backend + frontend)

Be careful not to confuse Lobby Service and Board Game Platform.

Authors

Fill e.g. names + link to github profiles in list below.

• Maximilian Schiedermeier - [https://github.com/kartoffelquadrat]
• ...