README.md

OpenSGS UI

📔 Table of Contents

• About the Project
  • Tech Stack
  • Features
• Getting Started
  • Prerequisites
  • Install Dependencies
  • Run Tests
  • Run Locally
  • Build Production
• Contributing
  • Code of Conduct
• License
• Contact

🌟 About the Project

Sanguosha was a popular Chinese board game, and QSanguosha is an open-source implementation of the game made by Mogara.

After many years of silence, we decided to adapt the game to a web application with modern technologies. That's why this project is founded. We name this project OpenSGS with the hope that QSanguosha's honorable community can be recovered one day. Instead of letting commercial business keep harming Sanguosha, we are acting to help people enjoy the original game.

This repository contains only the client/frontend. Find the backend at OpenSGS.

To preview the latest game, please go to https://opensgs-ui-mogara.vercel.app/.

👾 Tech Stack

• Client:
  • next.js
  • React
  • TypeScript
  • NextUI
  • Vercel
• Server:
  • Golang
  • Heroku
• DevOps:
  • GitHub Actions

🎯 Features

• Play Sanguosha in browser
• Easy to host
• Extensible

🧰 Getting Started

‼️ Prerequisites

• node.js >= 12
• yarn

⚙️ Install Dependencies

yarn install

🧪 Run Tests

yarn test

🏃 Run Locally

yarn start

🚩 Build Production

yarn build

👋 Contributing

Contributions are always welcome!

📜 Code of Conduct

Please read the Code of Conduct

⚠️ License

Licensed under the Apache License 2.0

🤝 Contact

Sunny Yang - [email protected]

Project Link: https://github.com/Mogara/opensgs-ui