# sgs

**Repository Path**: doublebit/sgs

## Basic Information

- **Project Name**: sgs
- **Description**: It's an Open-Source implement of San Guo Sha which is base on Node.js + React.
- **Primary Language**: Unknown
- **License**: GPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-01-29
- **Last Updated**: 2021-02-13

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# SGS (三国杀)

## Getting Started

1. Clone this repo:

```sh
$ git clone git@github.com:donle/sgs.git <working_directory>
```

2. Install dependencies:

```sh
$ cd <working_directory>
# cnpm is recommended if you're in China.
$ npm install
$ cd src/server
$ npm install
$ cd ../ui/platforms/desktop
$ npm install
```

3. Running. You need to start the server and client respectively.
```sh
# cwd is <working_directory>
# Start server
$ cd src/server
$ npm run dev #dev:win if you're using Windows.
# Start client
$ cd ./ui/platforms/desktop
$ npm run start:mac #start:win if you're using Windows.
```

## Configuration

You may configure how the clients and server execute and communicate.

edit `src/server/server_config.ts` to configure the server
edit `src/ui/platforms/desktop/src/client.config.ts` to configure the web client