Skip to content

Latest commit

 

History

History
158 lines (137 loc) · 4.33 KB

README.md

File metadata and controls

158 lines (137 loc) · 4.33 KB
Raw

CritiQ

Overview

CritiQ is an decentralised web application for handling customer reviews and feedback for products and services. It incentivises the reviewer and prevents them from posting gibberish reviews to maintain authenticity. Companies are assisted with LLMs to improve their competition in market. It provides a range of endpoints for managing users, reviews, and validation processes.

Website - Live link | Demo Video

Router Protocol - Code

Services used

Table of Contents

Avalanche

Contract address : "0x08eB668E21bee808e48A0449713b3494476Eb1b0",
Block  explorer Transaction Hash : "0x6e9e8cc04003759822505cdf5bbb39258ba71a4f76b07e30daa0ac343ee3ded9"
Block explorer url : https://subnets-test.avax.network/c-chain

Setup

Prerequisites

  • Node.js (v14 or higher)
  • MongoDB

Installation

  1. Clone the repository: git clone https://github.com/biswajit150803/critiqAll_backend.git cd critiqAll_backend

  2. Install dependencies: npm install

  3. Create a .env file with the following variables:

    PORT=your_port
  1. Start the server: npm start

Endpoints

BACKEND API:

User Endpoints

-Register a customer

 - Method: POST
 - Body: 
             {
                  "name": "string",
                  "companyEmail": "string",
                  "walletAddress": "string"
             }

-Login a customer

 - Method: POST
 - Body: 
             {
                  "walletAddress": "string"
             }

Company Endpoints

-Register a company

 - Method: POST
 - Body: 
         {
             "companyName": "string",
             "companyEmail": "string",
             "companyLogoUrl": "string",
             "companyDescription": "string",
             "walletAddress": "string",
         }

-Login a company

 - Method: POST
 - Body: 
             {
                  "walletAddress": "string"
             }

-OTP Verification

 - Method: POST
 - Body: 
             {
                  "email": "string",
                  "otp": "string"
             }

Phone Endpoints

  • Get Phone
    - Method: GET
    - Body:
                {
                    "phone": "string",
                }
  • Create a phone data 
     - Method: POST
 - Body:
             { 
                 "sid": "string", 
                 "id": "string", 
                 "phone": "string" 
             }
   ```

Question endpoints

    - URL: /
    - Method: POST
    - Body: 
                {
                  "productName": "string",
                  "productDescription": "string",
                  "productImageUrl": "string",
                  "isOrderIdTracking": "boolean",
                  "reviewDate": "string",
                  "excelFile": "string",
                  "questions": [
                                    {
                                        "question": "string",
                                        "type": "string",
                                        "options": [
                                                        "string"
                                                   ]
                                    }
                              ],
             }

Contributing

  1. Fork the repository
  2. Create a new branch (git checkout -b feature/your-feature)
  3. Commit your changes (git commit -m 'Add some feature')
  4. Push to the branch (git push origin feature/your-feature)
  5. Open a pull request

License

This project is licensed under the MIT License.