Tic-tac-toe UI

A UI for playing games of tic-tac-toe via an accompanying API.

• 🤔 Why does this repo exist?
• ⚠️ Requirements
• 🏃 Running locally
• ⚙️ Developing locally
• 📟 Contact
• Licence

🤔 Why does this repo exist?

This repo exists so that the the author can use it a playground for learning different web stacks, and for general tinkering.

Please do feel free to use this code, add GitHub issues, or open PRs, but know that you may not get a timely response.

⚠️ Requirements

This app requires the following to be installed in order to run locally.

• Node (version 16.x.x)

🏃 Running locally

This app relies on the tic-tac-toe API, so you’ll need to run that locally too. Follow the steps in its README.md and come back here when you have that running.

Steps for running this app:

• Clone this repo to a local directory
• In your terminal, run npm install && npm run build
• Optionally, run npm test to confirm that everything is set up properly. The output shouldn’t say the word “fail” or “failed” anywhere
• Run API_URL=http://localhost:3000/api API_KEY=hello BASE_URL=http://localhost:3001 npm start
• With your favourite web browser, go to the URL that’s logged in your terminal
• Have fun playing — let’s face it — a bit of a rubbish game

⚙️ Developing locally

Similar to the prior steps, but some varying commands to make it easier for checking your changes:

• Clone this repo to a local directory
• In your terminal, run npm install && npm run build:watch
• Open a new terminal tab or window and run API_URL=http://localhost:3000/api API_KEY=hello BASE_URL=http://localhost:3001 npm run start:dev
• Go to the URL that’s logged in the console output

📟 Contact

If you have any questions or comments about this app, or need help using it, please raise an issue.

---

Licence

This software is published by the Leaf Rogers under the MIT licence.