Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
skvrahul committed May 25, 2020
1 parent 9bea07d commit 1e3ab18
Show file tree
Hide file tree
Showing 4 changed files with 29 additions and 13 deletions.
42 changes: 29 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,45 @@
![Header](src/assets/UdaipurCover.png)

# Udaipur Game

A minimalistic clone of the popular board game [Jaipur](https://boardgamegeek.com/boardgame/54043/jaipur) with **Online Multiplayer** support built using [boardgame.io](github.com/nicoldavis/boardgame.io) and React JS.
A minimalistic clone of the popular board game [Jaipur](https://boardgamegeek.com/boardgame/54043/jaipur) with **Online Multiplayer** support built using [boardgame.io](github.com/nicoldavis/boardgame.io) and React JS.

## About the Game
Jaipur is a 2 player, trading card game where you and your opponent are traders and are trying to make the most money, buying and selling resources from the market. Resources initially sell for a larger amount and start to yield lesser money as more of them get sold in the market.

Jaipur is a 2 player, trading card game where you and your opponent are traders and are trying to make the most money, buying and selling resources from the market. Resources initially sell for a larger amount and start to yield lesser money as more of them get sold in the market.

Camels act as Wildcards, by allowing them to be traded for any other resource, however camels cannot be sold, only traded. This requires the player to strike a balance between taking and selling camels.

Find a quick game guide here:
[![Jaipur - Rules](https://img.youtube.com/vi/SD3g4gOf_N8/0.jpg)](https://www.youtube.com/watch?v=SD3g4gOf_N8).
Find a quick game guide here:
[![Jaipur - Rules](https://img.youtube.com/vi/SD3g4gOf_N8/0.jpg)](https://www.youtube.com/watch?v=SD3g4gOf_N8).

You can also find help within the Udaipur Website under [Game Help]()
The only departure from the original rules in Udaipur is the removal of **Seal of Excellence** to simplify and shorten the game.

## Development
- Run `npm install` to install the necessary packages
- Run `npm run client` to run the front-end client
- Run `npm run server` to run the game server


- Run `npm install` to install the necessary packages
- Run `npm run client` to run the front-end client
- Run `npm run server` to run the game server

## Deployment
- Set `APP_PRODUCTION=true` in **src/config.js**
- Run `npm run start` to deploy the app

You can deploy it yourself on Heroku.

- Set `APP_PRODUCTION=true` in **src/config.js**
- Run `npm run start` to deploy the app

You can deploy it yourself on Heroku using the button below .
[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/skvrahul/udaipur-game/tree/deploy_heroku)

## Screenshots

### Home Page

[Home Page](demo/udaipur_homePage.gif)

### Lobby

[Lobby](demo/udaipur_lobby.png)

### Game Board

[Game Board](demo/udaipur_board.png)
Binary file added demo/udaipur_board.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added demo/udaipur_homePage.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added demo/udaipur_lobby.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 1e3ab18

Please sign in to comment.