_{DISCLAIMER: Work In Progress}

Batchess

About | Development | Contributing | License

About

Blazingly fast digital carved wood game.

Tech Stack

• Vite + Vitest (build tool and testing framework)
• React (frontend libray, using only built-in state management)
• Motion (animations and dragging support for React)
• Cloudflare Pages (static file hosting service)

Development

To develop Batchess you will first need to install NodeJS.

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