Cardápio.Ninja

Welcome to the Cardápio.Ninja project!
This project represents the Frontend portion of the Cardápio.Ninja platform.
It was originally built with Vue 3 and migrated to Nuxt 3. Below, you will find a detailed README to help you understand the project and its features.

Note that the backend components, including technologies such as , are not included in this repository.

📝 Table of Contents

• Introduction
• Demo
• Technologies Used
• How It Works
• Setup

🔥 Demo

Experience the full functionality of Cardápio.Ninja at cardapio.ninja.

🛠 Technologies Used

Frontend

• Typescript
• Nuxt.js (Vue.js Framework)
• Pinia (State Management)
• Tailwind CSS
• Naive UI (UI Components)

Backend

• PHP/Laravel
• Amazon S3 (Cloud Storage)
• PagSeguro (Recurring payment plans)

❓ How It Works

Registration

1. Start by creating an account on Cardápio.Ninja.
2. Provide essential business information such as your business name and industry.

Menu Creation

1. Add your products or services and customize the menu to fit your style.
2. That's it! Your digital menu is ready to use.
3. Share and Receive Orders
4. Share your menu via a unique link or QR code.
5. Customers can browse your menu, build orders, and send them to you through WhatsApp.

👨‍💻 Installation

To get started with the frontend part of Cardápio.Ninja, follow these steps:

1. Clone the repository to your local machine.
2. Install the project dependencies using the following command:

npm install

3. Once you've installed the project, you can run it locally using the development server:

# Start the development server on http://localhost:3000
npm run dev