Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/skylightqp/marble

웹으로 만든 도시건설 보드게임
https://github.com/skylightqp/marble

boardgame nestjs prisma react

Last synced: 2 months ago
JSON representation

웹으로 만든 도시건설 보드게임

Host: GitHub
URL: https://github.com/skylightqp/marble
Owner: SkyLightQP
License: mit
Created: 2023-11-09T12:10:06.000Z (about 1 year ago)
Default Branch: main
Last Pushed: 2024-10-17T01:35:59.000Z (3 months ago)
Last Synced: 2024-10-19T03:14:10.184Z (3 months ago)
Topics: boardgame, nestjs, prisma, react
Language: TypeScript
Homepage: https://marble.daegyeo.me
Size: 5.61 MB
Stars: 5
Watchers: 2
Forks: 0
Open Issues: 15
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # 🎲 Marble

![React](https://img.shields.io/badge/react-%2320232a.svg?logo=react&logoColor=%2361DAFB) ![NestJS](https://img.shields.io/badge/nestjs-%23E0234E.svg?logo=nestjs&logoColor=white) [![CodeFactor](https://www.codefactor.io/repository/github/skylightqp/marble/badge)](https://www.codefactor.io/repository/github/skylightqp/marble) [![DeepScan grade](https://deepscan.io/api/teams/22633/projects/25916/branches/818052/badge/grade.svg)](https://deepscan.io/dashboard#view=project&tid=22633&pid=25916&bid=818052)

![Thumbnail](./docs/thumb.png)

> 웹으로 만든 도시건설 보드게임

## 시작하기

- 의존성 설치하기

```shell

yarn

```

- 프로젝트 준비과정 실행하기

```shell

yarn prepare

```

- 개발환경 설정하기

```shell

# Generate prisma client and backend sdk.

yarn predev

```

- 데이터베이스에 스키마 적용하기

```shell

yarn db:push

```

- 개발모드로 프로젝트 시작하기

```shell

yarn dev

```

- 운영모드로 프로젝트 빌드하기

```shell

yarn build

```

## 환경변수

- [.env.example](./.env.example) 참고

```dotenv

# 프론트엔드에서 사용합니다.

VITE_BASEPATH=

VITE_API_HOST=

# 백엔드에서 사용합니다.

TZ=

CORS_DEVELOPMENT_ORIGIN=

CORS_PRODUCTION_ORIGIN=

BCRYPT_SALT=12

ACCESS_TOKEN_SECRET=

REFRESH_TOKEN_SECRET=

REDIS_HOST=

REDIS_PORT=

# Backend Optional

REDIS_PASSWORD=

API_PREFIX=/

# Prisma 빌드 시 사용합니다.

DATABASE_URL="postgresql://user:password@host:port/database?schema="

```

## 프로젝트 구조

- apps

  - frontend

    - 프론트엔드 소스코드

  - backend

    - 게임서버, 웹서버 소스코드

- packages

  - api

    - 웹서버 API SDK

  - database

    - Prisma Schema, Client SDK

  - eslint-config-custom

    - ESLint 설정

  - tsconfig

    - tsconfig 설정

## 라이센스

[`MIT LICENSE`](LICENSE)