CustARd

Welcome to CustARd, your immersive augmented reality shopping experience. Explore products, engage with a chatbot for personalized recommendations, and visualize items in your space using AR/VR technology.

Table of Contents

• Installation
• Usage
• Test Cases & Evaluation Criteria
• Contributing
• License
• Contact

Installation

To get started with CustARd, follow these steps:

1. Clone the repository:

   git clone https://github.com/your-username/CustARd.git

Client Side

For setting up client side

2. Install dependencies:

   cd CustARd/client
   npm install

3. Start the application:

   npm run dev

Client will be running at http://localhost:5173/

Server Side

2. Install dependencies:

   cd CustARd/server
   npm install

3. Start the application:

   npm run dev

Server will be running at http://localhost:8000/

Make sure to create a .env file with the following configurations:

For Client dir .env

VITE_BACKEND=http://localhost:8000

For Server dir .env

DATABASE= mongodb_atlas_url
SECRET= password_secret
CLOUD_NAME= cloudinary_name
API_KEY= cloudinary_key
API_SECRET= cloudinary_api
CLOUDINARY_URL= cloudinary_url

Technologies Used

• Frontend: React.js, Shadcn
• Backend: Node.js
• Database: MongoDB
• Other: Reality Scan and Sketchfab for 3d models

Demo

Access the website live:- https://custard-gray.vercel.app/ Watch the video demo here

Screenshots

Usage

1. User Account Creation:

• Navigate to the website and create a user account.
• After account creation, you'll be redirected to the products page.

2. Product Exploration with Chatbot:

• On the products page, find the chat button in the bottom right corner.
• Interact with the chatbot by asking for recommendations or specific products.

3. AR Experience:

• Click on a recommended product to view its details on the product page.
• Explore comprehensive information, including price, specifications, and customer reviews.
• Use the "View AR" option on the product page to experience the product in augmented reality.

4. Seller Registration and Product Addition:

• Create your seller profile.
• Access the seller dashboard to manage products.
• Add new products and upload 3D product models following the provided instructions.

Test Cases & Evaluation Criteria

1. User and Seller Account Creation:

• Verify successful login and signup for both user and seller.
• Use the following credentials for testing:
  • User: email: test@test.com, password: test
  • Seller: email: seller@gmail.com, password: seller

2. Product Exploration with Chatbot:

• Test chatbot interactions for product recommendations using keywords.

3. AR Experience:

• Ensure the ability to view products in AR/VR mode for items with uploaded 3D models.

4. Adding New Products:

• Test seller profile creation, access to the seller dashboard, and the ability to add new products with 3D models.

Contributors

Contact Us

• Arghya Das - Twitter | GitHub | Mail
• Saakshi Raut - Twitter | GitHub | Mail
• Mayank Bansal - Twitter | GitHub | Mail

License

This is a personal project, not for commercial use. The design is original, and any resemblance is unintentional and we apologize for the same. In case of queries or feedback, you can reach out to us.