fill-out--your-app-friendly-name

fill-out--description

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

🤔 Why does this repo exist?

fill-out--why-does-this-exist

⚠️ Requirements

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

• Node (version 18.x.x)

🏃 Running locally

Steps for running this app:

• Clone this repo to a local directory
• In your terminal, run npm cit && npm run build. The output shouldn’t say the word “fail” or “failed” anywhere
• Run npm start
• With your favourite web browser, go to the URL that’s logged in your terminal

⚙️ 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 cit && npm run build:watch
• Open a new terminal tab or window and run 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.