Skip to content

Commit a109cfc

Browse files
themodernpkthemodernpk
authored
Merge pull request #3 from webreinvent/develop
Develop -> Master
2 parents 9cd4a14 + 0a64d90 commit a109cfc

17 files changed

+1043
-215
lines changed

‎content/1.getting-started/1.index.md

+28-41
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,40 @@
11
---
22
title: Introduction
3-
description: Welcome to Nuxt UI Pro documentation template.
3+
description: Welcome to the VaahStore documentation
44
---
55

6-
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.
6+
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.
77

8-
There are already many websites based on this template:
8+
## Key Features
99

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

17-
## Features
21+
## Why Choose VaahStore?
1822

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

29-
## Play online
34+
## Getting Started
3035

31-
You can start playing with this template in your browser using our online sandboxes:
36+
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.
3237

33-
::u-button
34-
---
35-
class: mr-4
36-
icon: i-simple-icons-stackblitz
37-
label: Play on StackBlitz
38-
target: _blank
39-
to: https://stackblitz.com/github/nuxt-ui-pro/docs/
40-
---
41-
::
42-
43-
::u-button
44-
---
45-
class: mt-2 sm:mt-0
46-
icon: i-simple-icons-codesandbox
47-
label: Play on CodeSandbox
48-
target: _blank
49-
to: https://codesandbox.io/s/github/nuxt-ui-pro/docs/
50-
---
51-
::
38+
## Join the VaahStore Community
5239

53-
Or open [Nuxt UI playground](https://ui.nuxt.com/playground).
40+
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.

‎content/1.getting-started/2.code-of-conduct.md

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
title: Code of Conduct
3+
description: Let's keep it light and friendly, but serious about respect!
4+
---
5+
6+
We want our community to be a fun and welcoming place for everyone. Here are a few guidelines to help us maintain that:
7+
8+
## Play Nice
9+
10+
- **No cyberbullying or trolling.** (We're all friends here, even if we disagree.)
11+
- **Keep it clean.** (No offensive language or inappropriate content, please.)
12+
- **Respect everyone's opinions.** (Even if they're really wrong.)
13+
- **Be patient and understanding.** (We're all human, and sometimes we make mistakes.)
14+
15+
## Unacceptable Behavior
16+
17+
- **No bullying or hate speech.** (Seriously, it's not cool.)
18+
- **Don't spam or troll.** (It's annoying, and nobody likes an annoying bot.)
19+
- **Respect people's privacy.** (Keep your snooping to a minimum.)
20+
21+
## If Something's Off
22+
23+
If you see something that doesn't feel right, please let us know. We'll investigate and fix or take appropriate action.
24+
25+
## Enforcement
26+
27+
We reserve the right to take action against individuals who violate this code of conduct, including warnings, temporary bans, or permanent bans.
28+
29+
By participating in our community, you agree to abide by this code of conduct.

‎content/1.getting-started/2.installation.md

-32
This file was deleted.

‎content/1.getting-started/3.usage.md

-142
This file was deleted.

‎content/2.mobile-app/1.onboarding/1.index.md

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
title: Introduction
3+
description: Starting with Mobile App Onboarding
4+
---
5+
6+
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.
7+
8+
## Features
9+
10+
- Product Browsing
11+
- Explore a vast catalog of products, categorized and filtered for easy navigation.
12+
- Product Details
13+
- View detailed product information, including high-quality images, descriptions, and customer reviews.
14+
- Shopping Cart
15+
- Add products to the cart, modify quantities, and apply discounts.
16+
- Secure Checkout
17+
- Process payments securely using various payment methods.
18+
- Order Tracking
19+
- Track the status of orders, from placement to delivery.
20+
- User Accounts
21+
- Create and manage user accounts, including address book, order history, and wishlists.
22+
- Push Notifications
23+
- Receive personalized notifications for order updates, promotions, and new arrivals.
24+
- Recommendations
25+
- Personalized Recommendations to cater each individual
26+
- Robust Logging and Analytics
27+
- Monitor app performance & issues. Also collect insights about what users prefer.
28+
- And Much More
29+
- All the things you think should be there, If not let us know and we will try to fit them in our roadmap.

‎content/2.mobile-app/1.onboarding/2.tech-stack.md

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: Tech Stack
3+
description: Technologies powering our platform.
4+
---
5+
6+
## TODO:

‎content/2.mobile-app/1.onboarding/_dir.yml

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
title: Onboarding

‎content/2.mobile-app/2.thought-processses/1.index.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: Introduction
3+
description: Thought process behind reaching to the decisions
4+
---
5+
6+
## Topics this section will cover
7+
8+
- Project Architecture
9+
- Decoupling Dependencies
10+
- State Management Patterns
11+
- Design Patterns
12+
- Performance Optimization
13+
- Security Considerations
14+
- Code Quality and Maintainability
15+
- Testing Strategies

0 commit comments

Comments
 (0)