Skip to content

Meldiron/syllable-game

Repository files navigation

πŸ—ƒοΈ Syllable Game

Playful way to learn word spelling.

πŸ‘€ Demo

Application deployed publically on Vercel: https://syllable-game.vercel.app/

🧰 Tech Stack

πŸ“š Documentation

Use endpoint /api/game to generate a game screen. Use URL parameters to configure it:

  • topic - title of the screen
  • words - Words to use in the game
  • extra - Secret that should be result of game

A few examples:

  • /api/game?words=yellow,indigo,purple,orange&topic=Music&extra=an
  • /api/game?words=piano,guitar,ukulele,trumpet,flute&topic=Music&extra=na

πŸ‘€ Setup Client

  1. Install libarries npm install
  2. Start server npm serve

πŸš€ Deploy client

  1. Build with npm build
  2. Deploy from .next

If deploying to static hosting, use npm run generate instead, and deploy files from out folder.

🀝 Contributing

No contribution guidelines yet, it's too small of a project.

πŸ–ΌοΈ Screenshots

Screenshot Screenshot

πŸ€– Auto-generated documentation

This is a Next.js project bootstrapped with create-next-app.

Getting Started

First, run the development server:

npm run dev
# or
yarn dev

Open http://localhost:3000 with your browser to see the result.

You can start editing the page by modifying pages/index.js. The page auto-updates as you edit the file.

API routes can be accessed on http://localhost:3000/api/hello. This endpoint can be edited in pages/api/hello.js.

The pages/api directory is mapped to /api/*. Files in this directory are treated as API routes instead of React pages.

Learn More

To learn more about Next.js, take a look at the following resources:

You can check out the Next.js GitHub repository - your feedback and contributions are welcome!

Deploy on Vercel

The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.

Check out our Next.js deployment documentation for more details.