Crabble

A fast-paced word game where you unscramble strings of words. Check it out!

Note

Hi, reviewer! I commit a lot - I apologise in advance. I've tried to take some steps to make reviewing easier: I'm committing less and have started working in different branches so I can group related commits into pull requests. And I've squashed commits in the same pull requests together (that's why you may see some extremely broken timestamps). So, please, when reviewing, don't start with the commit history, but with the Pull Requests tab instead!

Playing

• Pick a mode - Lightning, Infinite, or Spooky!

  • In Lighting mode, solve a set of three puzzles.
  • In Infinite mode, solve as many puzzles as you want (until you run out of puzzles, because there aren't that many 😭)
  • In Spooky mode, solve a set of three puzzles - but spooky!

• Solve a puzzle by ordering each series of words within it correctly.

  • Use Q or W to select words.
  • Use Space to pick up a word. Then, use your arrow keys to move it.
  • Hit Space again to set down the word.
  • Not using a keyboard? Don't worry. Drag any word to set it in the right place.

• Keep an eye on the time!

  • Moving a word gives you more time.
  • You'll lose if you run out of time.

About

This project was started for week 5 of Siege! It was a lot of work, but I'm quite happy with how it's shaping out :D

Credits

In use

• Vite + Svelte!
• Typescript & Python
• svelte-dnd-action (give it a star!)
• FastAPI
• ky

More!

• How To Use an Emoji as a Favicon Easily (at CSS-Tricks)

Running

This project has two parts: a backend API (crabnet!) and the website frontend.

You should start by cloning the repo:

$ git clone https://github.com/hs7t/cubby.git

Specific instructions for running each part follow.

Website

Spinning up the website is easy! From crabble-web:

1. Install packages

   $ npm install

2. Run a development server

   $ npm run dev

3. Get a build when you're ready

   $ npm run build     # check out ./dist afterward!

If you want, you can edit crabble-web/config.js to direct API requests to your own URL.

Backend

This is also easy! Making sure you've got Poetry and Python both installed, from crabnet:

1. Install dependencies

   $ poetry install

2. Run a development server

   $ poetry run fastapi dev 

Deployment is slightly trickier.