Skip to content

Latest commit

 

History

History
170 lines (144 loc) · 5.57 KB

README.md

File metadata and controls

170 lines (144 loc) · 5.57 KB

Gomoku Online

View the site

https://playgomoku.netlify.app/

About

MERN site that allows users to signup/login and play Gomoku online. Find, create, and play against others for rating. Rating is displayed on a leaderboard so you can see how your skills rank amongst everyone else!.
Uses long pro variation to make the game more fair.

Tech Stack

  • MERN
    • MongoDB Atlas as database
    • Express and NodeJS as backend
    • React as fronend
    • SocketIO as real-time communcation

Features

  • Accounts
    • Create and store profile and ratings in a database
    • Login from anywhere to play
    • Signout to stay secure
    • Browse as guest (but won't be able to play)
  • Game and Room
    • Join an available game
      • If no games are available then a new game will be created
    • Create custome game
      • Make your own game and invite or wait for others to join
      • Error checking to see if a roomname is taken
      • Password option to make a room private
    • Game's roomname created from Random Word Api so that no roomnames are the same
    • Display list of rooms
      • roomname, playercount, password required, and actions
      • Actions include:
        • If a room is not filled, then a Join button is shown
        • If a room is filled, then a In session button is shown
      • Filtering of rooms to allow for easy search
    • After a game is made or finished, the rooms are updated for real time viewing
  • Leaderboard
    • Display list of users
    • username, avatar, rating
    • Filtering of users to allow for easy search
  • Local Play
  • Leaving a game while unfinished will cause the leave to be penalized and the remaining player to be notified of their leave
  • Leaving a game before it has started will prompt the user, if the user continues, then the lobby will be updated accordingly
  • React Error Boundary

Developer Features

  • Frontend

  • Backend

    • Express
    • bycryptjs
      • Securely hash a user's password for security
    • nodemon
      • Autoreload when changes to server
    • dotenv
      • Hides secrets
    • cors
      • Avoid cors errors
    • Body-parser
      • Correctly parse JSON for information retrieval and usage

  • Database

    • MongoDB Atlas
      • Mongoose for Object Data Modeling of MongoDB

  • SocketIO

    • Real-time communication between clients <-> clients and clients <-> server

Installation

Get the source code:

git clone https://github.com/minh100/Gomoku.git
cd Gomoku

Install all dependecies at the root of the repo:

npm install

Deployment and Updating

Updating Work

At the root of the repo push to Git:

cd Gomoku
git add .
git commit
git push origin master
  • To update server do step 4 of Deploying to Server-side
  • To update client do Actual Deployment and New Deployments of Deploying to Client-side

Deploying to Client-side (Netlify)

  • Inital Deployment Setup
    1. At the client folder install Netlify CLI 
      npm install netlify-cli -g
    2. In package.json, add a homepage property 
      "homepage": ".",
    3. Then to fix the issue of client-side rendering, navigate to client/public and add a plain text _redirects file with the text 
      /* /index.html 200
  • Actual Deployment and New Deployments
    1. Build the app (make sure you are in the client folder) 
          npm run build
    2. Predeploy to see if the site is how you want it (choose build as the publishing directory) 
      netlify deploy
    3. Deploy to production (choose build as the publishing directory) 
      netlify deploy --prod

Deploying to Server-side (Heroku)

  • Since we are using Heroku to deploy the backend server, we need to take into consideration of the subfolders we want to deploy
    • In this case we only want to deploy the server folder
      1. Create a Heroku app
      2. Navigate to root of repo
      3. Create the heroku remote using the command 
        heroku git:remote -a <heroku_url>
      4. Now still at the root of the repo, run 
        git subtree push --prefix <pathToSubfolder> heroku master
        As an examaple we only want to deploy the server folder
        git subtree push --prefix server heroku master
  • Heroku Reference