WordGrid

A grid-based puzzle game to test your vocabulary

Setting up Local Development

To setup local development, clone the repository and then install the dependencies for both the client and server. Please note that Bun is used for the server.

If you are using an editor that does not have built-in support for .editorconfig files (e.g. VSCode), please install an extension that provides support for it (e.g. EditorConfig for VSCode) to follow the style guidelines for this repository.

git clone https://github.com/wordgrid-game/wordgrid.git
cd wordgrid
npm install
cd server
bun install
cd ..

Core Architecture

The root directory is for the client (our website), with a subdirectory (server) for the backend service.

License

We use a custom source-available license. Please read it over here.

Contributing

Please follow the contribution guide here.

Code of Conduct

Please respect our community and maintainers by following the standards set out in our Code of Conduct.

Security

Follow the security policy and use GitHub's built in security vulnerability reporting system if you find any security issues.

Contributors