DecoAR

Transform your space with DecoAR: visualize and customize furniture in your home using augmented reality!

View Demo · Report Bug

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contributing
5. License
6. Contact

About The Project

DecoAR is a web application that harnesses augmented reality (AR) technology to help users visualize furniture and decor in their own living spaces before making a purchase. Browse through a comprehensive catalog of products, view high-quality 3D models, and place them in your environment using your device's camera.

(back to top)

Built With

(back to top)

Getting Started

Follow these easy steps to get a local copy up and running.

Prerequisites

• npm

  npm install npm@latest -g

• Obtain API key for

  • Clerk Authentication: Create an project and get Clerk_Publishable_key and Clerk_Security_Key

Installation

1. Clone the repo

   git clone git@github.com:DecorAR-Team/DecoAR.git

2. Create your own .env file and copy the description below replacing the placeholder information with the Clerk Api Keys and database connection URI:

   MONGODB_URI=[ENTER_MONGODB_CONNECTION_STRING]
   NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY=[ENTER_CLERK_PUBLISHABLE_KEY]
   CLERK_SECRET_KEY=[ENTER_CLERK_SECRET_KEY]
   NEXT_PUBLIC_CLERK_SIGN_IN_URL=/sign-in
   NEXT_PUBLIC_CLERK_SIGN_UP_URL=/sign-up

3. Install NPM packages

   npm install

4. Database Setup

• Before running the project locally, you need to create a MongoDB database named "decoar".

• Inside the decoar database, create the following collections:

  Category
  Product
  ProductWith3d
  Subcategory
  SubcategoryWithProductIds

• Insert JSON data into the collections:

  Navigate to each collection (e.g., Category) in MongoDB Compass.
  Click on Add Data and then Import File.
  Select the appropriate JSON file from lib/json directory on your local machine and click Open.
  Repeat this process for each collection, importing the corresponding JSON files.
  

5. Start the app

   npm run dev

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See license.txt for more information.

(back to top)

Contact

DecoAr Organization: Github - LinkedIn - decoarteam@gmail.com

Tetiana Bortnyk - Github - LinkedIn - tatyanabortnik@gmail.com

Sindhu Yogu - Github - LinkedIn - sindy96jan@gmail.com

Sulo Siguur- Github - LinkedIn - sulo.siigur@gmail.com

Charbel Rouhana - Github - LinkedIn - charbelmrouhana@gmail.com