/tsufia-frontend

Build a Mafia Game Using React and Socket.io

Primary LanguageTypeScriptMIT LicenseMIT

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

Tsufia

소켓을 활용하여 실시간으로 적용되는 마피아 게임을 만들어보자!
개발 후기 »
Backend Repo »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Copyright
  8. Contact
  9. Acknowledgments

About The Project

Tsufia Introduction


Mafia Screenshot Citizen Screenshot
Tsufia Screen Shot Tsufia Screen Shot

(back to top)

Built With

(back to top)

Getting Started

다음은 프로젝트를 로컬로 설정하는 방법에 대한 예입니다. 로컬 복사본을 설정하고 실행하려면 다음 간단한 예제 단계를 수행하십시오.

Prerequisites

다음은 소프트웨어를 사용하는 데 필요한 항목을 나열하고 설치하는 방법의 예입니다.

  • npm

    npm install npm@latest -g

    or

  • yarn

    npm install yarn@latest -g

Installation

  1. Google CloudKakao Developers Application에서 CLIENT_ID 및 SECRET_KEY를 가져옵니다.
  2. 레포지토리 클론
    git clone https://github.com/ShigatsuEl/tsufia-frontend.git
  3. NPM 패키지들 설치
    npm install
    // or
    yarn install
  4. 루트에서 .env파일 생성 후 API KEY를 입력합니다.
    REACT_APP_EXPIRES_IN = ENTER_YOUR_CUSTOM_EXPIRES_IN;
    REACT_APP_GOOGLE_CLIENT_ID = ENTER_YOUR_API;
    REACT_APP_GOOGLE_SECRET = ENTER_YOUR_API;
    REACT_APP_KAKAO_CLIENT_ID = ENTER_YOUR_API;

(back to top)

Usage

npm start
# or
yarn start

아래 이미지를 클릭하여 프로젝트가 어떻게 사용되는지 확인할 수 있습니다.

IMAGE ALT TEXT HERE

(back to top)

Roadmap

  • 로그인 및 회원가입
  • 소셜 로그인
    • 구글
    • 카카오
  • 패스워드 확인 및 프로필 업데이트
  • 소켓 연결
    • 방 입장/수정/퇴장 실시간 연동
    • 게임 사이클 실시간 연동
    • 새로고침 후에도 소켓 연결 유지(실수로 게임 중단되는 것을 방지)

제안된 기능(알려진 이슈)의 전체 목록은 미해결 이슈를 참조하십시오.

(back to top)

Contributing

기여는 오픈 소스 커뮤니티를 배우고, 영감을 주고, 창조할 수 있는 놀라운 장소로 만드는 것입니다. 어떠한 기여도 대단히 감사합니다:)

여러분이 더 좋은 제안을 가지고 있는 경우 레포지토리를 포크하고 풀 리퀘스트 요청을 작성하십시오. 또한 "향상" 태그로 이슈를 간단히 열 수도 있습니다. 프로젝트에 스타를 주는 것을 잊지 마세요! 다시 한 번 감사드립니다!

  1. 프로젝트를 Fork합니다
  2. Fork된 프로젝트로부터 로컬 환경으로 복사합니다.(git clone https://github.com/your_name/tsufia-frontend)
  3. 새로운 브랜치를 생성합니다 (git checkout -b feature/AmazingFeature)
  4. 변경된 점을 커밋으로 남깁니다 (git commit -m 'Add some AmazingFeature')
  5. 브랜치를 푸쉬합니다 (git push origin feature/AmazingFeature)
  6. 풀 리퀘스트를 오픈합니다

(back to top)

License

MIT 라이센스에 따라 배포됩니다. 자세한 내용은 LICENSE.txt를 참조하십시오.

(back to top)

Copyright

프로젝트에서 사용된 이미지와 오디오들은 아래의 라이센스를 따르고 있습니다.

Contact

Minchan Lee(ShigatsuEl) - shigatsu970704@gmail.com

Project Link: https://github.com/ShigatsuEl/tsufia-frontend

(back to top)

Acknowledgments

(back to top)