diff --git a/README.md b/README.md index f4da3c4..a89a288 100644 --- a/README.md +++ b/README.md @@ -1,34 +1,221 @@ -This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app). +
+ Co Tuong is a traditional intellectual game played on a square board with pieces like General, Advisor, Horse, Chariot, Cannon, and Soldier. The goal is to checkmate the opponent's General by moving the pieces according to specific rules. This game requires strategy and prediction skills and is an integral part of entertainment culture in many countries. The objective of this project is to develop the game of Co Tuong on a Website platform, allowing online play and connectivity through the internet. +
+ +++ ++ This is a product developed for the specialized projects at HUTECH University. The purpose of this project is to support the research process of course projects at the university. This project is not intended for commercial purposes. +
++ We are a group of students at HUTECH University. This project is a part of our learning process! +
+
+ If you are interested or have suggestions for this project, please contact the contributors on this project! +
+ +## 🚀 Getting Started + +To get started with the Co Tuong FrontEnd, follow the installation instructions outlined below: + +1. Clone this repository: + +```bash +git clone https://github.com/Owlvernyte/cotuong-frontend +``` + +2. Navigate to the project directory: + +```bash +cd cotuong-frontend +``` + +3. Install dependencies: + +```bash +yarn install +``` + +4. Set up environment variables (if any): + +- Create a `.env` file at the root of the project +- Provide the required environment variables (refer to `.env.example`) + +5. Start the development server: ```bash -npm run dev -# or yarn dev -# or -pnpm dev ``` -Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. +6. Access the app at `http://localhost:3000` + +## 📚 Features + +1. **Account Registration/Login:** + - Easily create an account or log in using your Google or Discord credentials for quick access to the platform. + +2. **Create or Join Game Rooms:** + - Create your own game room and invite friends, or join existing rooms to play Co Tuong online with players from around the world. + +3. **Play Against System Bot:** + - Challenge your skills by playing against our advanced system bot, designed to provide a challenging and engaging gaming experience. + +4. **Real-time Chat:** + - Interact and strategize with fellow players in real-time using our built-in chat feature within the game rooms. + +5. **Leaderboard:** + - Compete with other players and climb the ranks on our leaderboard, showcasing your achievements and skills in Co Tuong. + +6. **Match History:** + - Review and analyze your past games with our match history feature. Learn from your victories and defeats to enhance your gameplay. + +7. **Tournaments:** + - Participate in various tournaments hosted on our platform. Test your skills against the best and compete for prestigious titles and rewards. + +-> How to Get Started: + +1. **Sign Up or Log In:** + - Register for an account or log in with your Google/Discord account to start playing Co Tuong Chess online. + +2. **Create or Join a Room:** + - Create a new game room or join an existing one to begin your game. Invite friends or challenge players waiting for opponents. + +3. **Play and Enjoy:** + - Engage in thrilling matches against real opponents or challenge our system bot. Use the chat feature to communicate and enjoy the game to the fullest. + +4. **Track Your Progress:** + - Monitor your progress on the leaderboard, review your match history, and participate in tournaments to improve your skills and achieve higher rankings. + +Join us on our Co Tuong Online platform and experience the excitement of traditional board gaming in the digital world! Have fun, make new friends, and become a Co Tuong master. Let the games begin! 🎉 + +## ✅ Built with + +The Co Tuong FrontEnd is built with the following technologies: + +- [NextJS](https://nextjs.org/) - The React Framework for the Web +- [TailwindCSS](https://tailwindcss.com/) - Rapidly build modern websites without ever leaving your HTML +- [Tanstack](https://tanstack.com/) - High-quality open-source software for web developers + +## 🔵 Web API + +The Web API serves as the **backend** for the Co Tuong system. It handles various requests and provides the necessary functionalities. You can explore the Web API by visiting the following URL: [Web API](https://cotuong.azurewebsites.net/swagger/index.html) + +⚠ You can watch it because this project is still a work in progress, not yet in use! + +## 🟢 User Web Interface + +The User Web Interface is the user-facing web interface for the Co Tuong system. It gives users access to the game. You can access the User Web Interface at: [User Web Interface](https://cotuong.nyte.tk/) + +▶ In the future we will develop on mobile! + +## 💬 Source Code + +The source code for the Co Tuong project is publicly available on GitHub. + +⚠ You can watch it because this project is still a work in progress, not yet in use! + +### Backend Source Code + +The backend source code repository can be found at: [Backend Source Code](https://github.com/Owlvernyte/CoTuongBackend) + +### Frontend Source Code + +The frontend source code repository can be found at: [Frontend Source Code](https://github.com/Owlvernyte/cotuong-frontend) + +Please contact us if you would like to contribute to this project! -You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file. +## 💌 Contributing -This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font. +Contributions to the Co Tuong FrontEnd are welcome! If you find any bugs, issues, or have suggestions for improvements, please open an issue on the GitHub repository. -## Learn More +- Fork this repository. +- Create your new branch with your feature: `git checkout -b my-feature`. +- Commit your changes: `git commit -am 'feat: My new feature'`. +- Push to the branch: `git push origin my-feature`. +- Submit a pull request 👌. -To learn more about Next.js, take a look at the following resources: +## 🏆 Contributors -- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API. -- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial. +We are students at HUTECH university: -You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome! +
+
+ + Hoang Tien Dat + |
+
+
+ + Nguyen Hong Thai + |
+
+
+ + Truong Thuc Van + |
+
+
+ + Huynh Nhat Truong + |
+
+
+ + Pham Huynh Nhat Truong + |
+
+
+ + Nguyen Quoc Kha + |
+
+
+ + Bui Thanh Dat + |
+
+
+ + Le Nguyen Viet Duong + |
+