Skip to content

brentvollebregt/monopoly-money

master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Monopoly Money Banner

Manage your finances in a game of Monopoly from the browser.

🌐: monopoly-money.nitratine.net

πŸ› οΈ Setup

  1. Clone the repo and cd into the project.
  2. Install dependencies by executing npm install.
  3. Setup environment variables. This can be done two ways:
    • Set the environment variables in the current terminal session
    • Copy the .env.example files in the server and client packages and populate them:
      • Examples are at: packages/server/.env.example and packages/client/.env.example
      • Copy these using cp .env.example .env and populate them both.
  4. Build dependencies using npm run build.
  5. Execute npm start to start the server.

You may need to set CI=false when building to ignore the warnings from the frontend project.

The environment variables that can be used are (can also be found in .env.example files):

  • REACT_APP_API_ROOT (optional): The route that the client requests. Not setting this will default to window.location.origin.
  • SERVER_ALLOWED_ORIGINS (optional): The origins that are served by the server. Not setting this is the equivalent of setting CORS to *.

πŸ§ͺ Development Setup

When running the client in development mode using npm run client:dev, the client will use the REACT_APP_API_ROOT environment variable value to decide where to send requests. If this is not provided, the current hosted URL will be used.

npm run server:dev can also be used for development of the server; this allows for hot-reloading. Running the client using npm run client:dev and setting REACT_APP_API_ROOT to where the server is running will allow for a development setup with hot-reloading.

launch.json also offers the ability to connect and debug the the server when running npm run client:dev.

Screenshots

TODO TODO TODO
TODO TODO TODO

πŸ“ Features

  • Multiple games can be hosted on the server at once
  • Each player uses their own device; everyone joins one game
  • Send money between players with ease - no need to sort out change
  • Realtime - players get notified when an event occurs immediately.
  • The person that created the game is the banker. This person can:
    • Give money to players from the bank (and take money)
    • Give free parking to players
    • Update player names
    • Delete players
    • Stop new people from joining the game
    • End the game completely
  • History is recorded of each game event that can be viewed by all players

❓ Why?

If you have ever played the credit card edition of Monopoly, you will appreciate how much faster the game moves without having to count cash. This webapp substitutes the need for cash in a game of monopoly for a mobile-banking-like solution where players can easily send each other virtual currency.

🌐 Deployment

This application was designed to have the server deployed on Heroku (with the client) and a separate client on GitHub Pages.

  • When deploying with Heroku, make sure to set NPM_CONFIG_PRODUCTION to false in config vars otherwise packages will not be installed correctly.
  • The client deployment workflow can be found in main.yml.

πŸ’‘ Potential Future Ideas

  • Requests
    • Game event
    • Bank and players can get them
    • Shows at the top of funds / top of bank page
    • Can approve or decline
    • Approval triggers a payment
    • Doesn't how show in history
    • This request is then removed in the game state when approved, declined.
    • Hold down on players tile?

About

A NodeJS server and React frontend that helps you manage your finances in a game of Monopoly from the browser πŸ’Έ

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published