An in-browser implementation of the traditional German Doppelkopf card game.
This game has been in development for a while and still isn't feature complete. While you'll get a pretty solid experience of the basic game, you will see that some things you might expect from a Doppelkopf game are still missing. Also, note that this game is strictly desinged to be a single player game. You won't be able to play against real humans with this game.
Things that are not yet part of the game but are planned to be built eventually include:
- Playing solo
- Weddings ("Hochzeit")
- Custom rules: "Karlchen", "Zweite Dulle sticht die erste", "Schweinchen", etc.
The game is implemented using Typescript and vue.js. It's a small, frontend-only standalone web application that can be hosted anywhere you can host static websites. It's using Vite for building, bundling, and running the application locally.
To work on the application, check out this repository and open the root of this repo in your terminal.`s
Make sure you use the latest node LTS version.
Install dependencies:
npm install
Serve the development server on localhost:5173.
npm run dev
Run the tests before and after making changes:
npm run test
Format your code via:
npm run format
Lint your code via:
npm run lint
And build for production (with minification) using:
npm run build
We're using vue's single-file components with <script setup>. Check out the script setup docs to learn more about this pattern.
We're using composition style API for vue components.
Vue components are strictly only doing UI work. The entire game logic lives outside of vue components and is completely framework-agnostic. The game code shouldn't know whether the game is running in a browser or any other environment. The models/ directory is the home of the game logic exclusively. Separating UI from game logic allows us to test-drive our game logic's implementation and makes the game independent of any chosen frontend technology. There are no plans to use anything else than vue for the foreseeable future, but keeping that option is good and helps us keep the codebase healthy in the long-term.
We're very serious about testing. All bug fixes and new features should come with new tests. Unit tests with Jest (we're using Vitest but the API is compatible). End-to-End tests are not a thing at the moment (we used to have a few, but our unit tests seem to be sufficient for now).
If you want to set up your development environment, here are a few helpful pointers:
For VSCode, use the Volar plugin to work with vue seamlessly.
We're using prettier to format the code. Either set up your editor of choice to integrate prettier or make sure to run prettier before committing changes via npm run format.
We're also using eslint for static code analysis and to point out and find potential problems and inconsistencies. You can run it via npm run lint or by setting up your editor of choice correctly.
Contributions in the form of feature requests, bug reports, and small bug fixes are welcome. I am not looking for pull requests that introduce new or change existing functionality in a non-trivial way. See CONTRIBUTING.md for details.