https://github.com/aod/batchess
Carved wood simulator
https://github.com/aod/batchess
batchess chess motion react vite vitest
Last synced: about 2 months ago
JSON representation
Carved wood simulator
- Host: GitHub
- URL: https://github.com/aod/batchess
- Owner: aod
- License: mit
- Created: 2022-09-09T14:43:36.000Z (almost 4 years ago)
- Default Branch: grandmaster
- Last Pushed: 2023-07-12T06:55:30.000Z (almost 3 years ago)
- Last Synced: 2025-06-28T07:42:38.031Z (12 months ago)
- Topics: batchess, chess, motion, react, vite, vitest
- Language: TypeScript
- Homepage: https://batchess.yatko.dev
- Size: 502 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[batchess]: https://batchess.yatko.dev
DISCLAIMER: Work In Progress
Batchess
About
|
Development
|
Contributing
|
License
# About
Blazingly fast digital carved wood game.
## Tech Stack
[vite]: https://vitejs.dev
[vitest]: https://vitest.dev
[react]: https://reactjs.org
[motion]: https://www.framer.com/motion
[cfpages]: https://pages.cloudflare.com/
- [Vite][vite] + [Vitest][vitest] (build tool and testing framework)
- [React][react] (frontend libray, using only built-in state management)
- [Motion][motion] (animations and dragging support for React)
- [Cloudflare Pages][cfpages] (static file hosting service)
# Development
To develop Batchess you will first need to install
[NodeJS](https://nodejs.org/en/download/).
Next, download the source code and run the following commands in the root
directory of the project:
1. Install dependencies:
```
npm install
```
2. Start dev environment:
```
npm run dev
```
3. Visit the url shown in the output to view the application.
## Building
Running this command will build the project and output all files to `dist/`:
```
npm run build
```
## Testing
Simply run the following command to run all tests:
```
npm test
```
## Typecheck
I like to run the following command to watch for changes and typecheck
the project:
```
npx tsc --noEmit -w
```
# Contributing
Bug reports and fixes are appreciated as well as ideas or discussions!
However, since this project is a work in progress, please only create pull
requests which link to an issue in this GitHub repo.
Thanks for your comprehension.
# License
MIT