Skip to content

Develop -> Master #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 12, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
69 changes: 28 additions & 41 deletions content/1.getting-started/1.index.md
Original file line number Diff line number Diff line change
@@ -1,53 +1,40 @@
---
title: Introduction
description: Welcome to Nuxt UI Pro documentation template.
description: Welcome to the VaahStore documentation
---

This template is a ready-to-use documentation template made with [Nuxt UI Pro](https://ui.nuxt.com/pro), a collection of premium components built on top of [Nuxt UI](https://ui.nuxt.com) to create beautiful & responsive Nuxt applications in minutes.
VaahStore is a cutting-edge, open-source headless e-commerce platform designed to revolutionize the online shopping experience. VaahStore offers a fast, efficient, and feature-rich solution for businesses of all sizes.

There are already many websites based on this template:
## Key Features

- [Nuxt](https://nuxt.com) - The Nuxt website
- [Nuxt UI](https://ui.nuxt.com) - The documentation of `@nuxt/ui` and `@nuxt/ui-pro`
- [Nuxt Image](https://image.nuxt.com) - The documentation of `@nuxt/image`
- [Nuxt Content](https://content.nuxt.com) - The documentation of `@nuxt/content`
- [Nuxt Devtools](https://devtools.nuxt.com) - The documentation of `@nuxt/devtools`
- [Nuxt Studio](https://nuxt.studio) - The pro version of Nuxt Content
- Headless Architecture
- Unrestricted flexibility to build custom storefronts and integrate with any device or platform.
- Open-Source
- Empowering developers to customize and extend the platform to meet specific needs.
- Fast and Efficient
- Optimized performance for seamless user experiences.
- Easy to Use
- Intuitive interface and developer-friendly tools for rapid development.
- Comprehensive Features
- Built-in functionalities like product catalogs, shopping carts, checkout processes, and more.

## Features
## Why Choose VaahStore?

- Powered by [Nuxt 3](https://nuxt.com)
- Built with [Nuxt UI](https://ui.nuxt.com) and [Nuxt UI Pro](https://ui.nuxt.com/pro)
- Write content with [MDC syntax](https://content.nuxt.com/usage/markdown) thanks to [Nuxt Content](https://content.nuxt.com)
- Compatible with [Nuxt Studio](https://nuxt.studio)
- Auto-generated sidebar navigation
- Full-Text Search out of the box
- Beautiful Typography styles
- Dark mode support
- And more...
- Unleash Your Creativity
- Design **stunning, personalized storefronts without compromise**.
- Skyrocket Your Sales
- Deliver **blazing-fast** performance and seamless user experiences.
- Future-Proof Your Business
- Built on the latest technologies, VaahStore ensures you **stay ahead of the curve**.
- Take Control of Your E-commerce Destiny
- With complete **customization** and **extensibility**, you're in the driver's seat.
- Join a Thriving Community
- Benefit from a global community of developers, **sharing knowledge and innovation**.

## Play online
## Getting Started

You can start playing with this template in your browser using our online sandboxes:
To begin your journey with VaahStore, refer to our comprehensive documentation and community resources. Our dedicated team is committed to providing support and guidance throughout the development process.

::u-button
---
class: mr-4
icon: i-simple-icons-stackblitz
label: Play on StackBlitz
target: _blank
to: https://stackblitz.com/github/nuxt-ui-pro/docs/
---
::

::u-button
---
class: mt-2 sm:mt-0
icon: i-simple-icons-codesandbox
label: Play on CodeSandbox
target: _blank
to: https://codesandbox.io/s/github/nuxt-ui-pro/docs/
---
::
## Join the VaahStore Community

Or open [Nuxt UI playground](https://ui.nuxt.com/playground).
Connect with fellow developers, share knowledge, and contribute to the future of e-commerce. Join our GitHub community to stay updated on the latest developments and best practices.
29 changes: 29 additions & 0 deletions content/1.getting-started/2.code-of-conduct.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
title: Code of Conduct
description: Let's keep it light and friendly, but serious about respect!
---

We want our community to be a fun and welcoming place for everyone. Here are a few guidelines to help us maintain that:

## Play Nice

- **No cyberbullying or trolling.** (We're all friends here, even if we disagree.)
- **Keep it clean.** (No offensive language or inappropriate content, please.)
- **Respect everyone's opinions.** (Even if they're really wrong.)
- **Be patient and understanding.** (We're all human, and sometimes we make mistakes.)

## Unacceptable Behavior

- **No bullying or hate speech.** (Seriously, it's not cool.)
- **Don't spam or troll.** (It's annoying, and nobody likes an annoying bot.)
- **Respect people's privacy.** (Keep your snooping to a minimum.)

## If Something's Off

If you see something that doesn't feel right, please let us know. We'll investigate and fix or take appropriate action.

## Enforcement

We reserve the right to take action against individuals who violate this code of conduct, including warnings, temporary bans, or permanent bans.

By participating in our community, you agree to abide by this code of conduct.
32 changes: 0 additions & 32 deletions content/1.getting-started/2.installation.md

This file was deleted.

142 changes: 0 additions & 142 deletions content/1.getting-started/3.usage.md

This file was deleted.

29 changes: 29 additions & 0 deletions content/2.mobile-app/1.onboarding/1.index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
title: Introduction
description: Starting with Mobile App Onboarding
---

VaahStore Mobile App is a feature-rich mobile application, designed to provide a seamless shopping experience on smartphones and tablets. It leverages the power of the VaahStore backend API to offer a wide range of features.

## Features

- Product Browsing
- Explore a vast catalog of products, categorized and filtered for easy navigation.
- Product Details
- View detailed product information, including high-quality images, descriptions, and customer reviews.
- Shopping Cart
- Add products to the cart, modify quantities, and apply discounts.
- Secure Checkout
- Process payments securely using various payment methods.
- Order Tracking
- Track the status of orders, from placement to delivery.
- User Accounts
- Create and manage user accounts, including address book, order history, and wishlists.
- Push Notifications
- Receive personalized notifications for order updates, promotions, and new arrivals.
- Recommendations
- Personalized Recommendations to cater each individual
- Robust Logging and Analytics
- Monitor app performance & issues. Also collect insights about what users prefer.
- And Much More
- All the things you think should be there, If not let us know and we will try to fit them in our roadmap.
6 changes: 6 additions & 0 deletions content/2.mobile-app/1.onboarding/2.tech-stack.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Tech Stack
description: Technologies powering our platform.
---

## TODO:
1 change: 1 addition & 0 deletions content/2.mobile-app/1.onboarding/_dir.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
title: Onboarding
15 changes: 15 additions & 0 deletions content/2.mobile-app/2.thought-processses/1.index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: Introduction
description: Thought process behind reaching to the decisions
---

## Topics this section will cover

- Project Architecture
- Decoupling Dependencies
- State Management Patterns
- Design Patterns
- Performance Optimization
- Security Considerations
- Code Quality and Maintainability
- Testing Strategies
Loading