Skip to content

Latest commit

 

History

History
52 lines (33 loc) · 2.27 KB

README.md

File metadata and controls

52 lines (33 loc) · 2.27 KB

PalatePanda 🐼

Commitizen friendly Depfu CodeScene Code Health

Welcome to PalatePanda, a recipe sharing platform built with Nuxt.js, Firebase and deployed on Vercel. It allows users to create, share, and discover delicious recipes from around the world. The project is designed with a focus on user experience, with a clean and intuitive interface that makes browsing and sharing recipes a breeze.

📚 Table of Contents

💻 Recommended IDE Setup

For the best development experience, we recommend:

For more information, refer to the Nuxt 3 documentation.

🚀 Setup

To get started with PalatePanda, follow these steps:

  1. Clone the repository: git clone https://github.com/yourusername/PalatePanda.git
  2. Navigate to the project directory: cd PalatePanda
  3. Install the dependencies: npm install

🏃‍♀️ Running the Development Server

To start the development server, run npm run dev. This will start the server on http://localhost:3000.

To host the development server on the network, run npm run dev -- --host.

🤝 How to Contribute

Run checks, format files and commit with Commitizen:

npm run commit

Run checks, format files, and push to Github:

npm run push