README.md

Nuxt 3 Bird Avatars

A fun bird generator loosely based on the bird designs of Kurzgesagt

View Demo

📔 Table of Contents

• About the Project
  • Screenshots
  • Tech Stack
• Getting Started
  • Installation
  • Running Tests
  • Run Locally
  • Deployment
• License
• Contact
• Acknowledgements

🌟 About the Project

📷 Screenshots

👾 Tech Stack

• Nuxt 3
• Vue 3
• VueUse
• TypeScript
• UnoCSS

🧰 Getting Started

🧪 Running Tests

To run tests, run the following command

  npm run test

🏃 Run Locally

Clone the project

  git clone https://github.com/jclong98/bird-avatars

Go to the project directory

  cd bird-avatars

Install dependencies

  npm i

Start the server

  npm run dev

🚩 Deployment

This project is deployed on Netlify with server functions to handle the generation of svg images

💎 Acknowledgements

• hashrock for making https://deno-avatar.deno.dev/
• Awesome README