Home

Dark-Patterns Documentation

Welcome to the official documentation for the Dark-Patterns project! This documentation serves as a comprehensive guide to understand, set up, and contribute to the project.

Table of Contents

1. Introduction
2. Getting Started
   • Installation
   • Front End (Extension)
   • Back End (Server)
3. Usage
   • Running Compliance Assessment
   • Viewing Results
4. Contributing
   • Team - Exploit Elits
5. Project Overview
6. License

Introduction

Dark-Patterns is a project focused on assessing the compliance of e-commerce platforms with data transparency regulations, such as GDPR, CCPA, and other relevant norms in India. The goal is to identify potential violations and provide insights into the level of compliance through the use of algorithms and machine learning.

Getting Started

Installation

To set up the Dark-Patterns project on your local machine, follow these steps:

1. Clone the repository:

   git clone https://github.com/Thennavan-Hex/Dark-Patterns.git

2. Navigate to the project directory:

   cd Dark-Patterns

Front End (Extension)

1. Navigate to the Extension directory:

   cd Extension

2. Follow the instructions in the Extension README for specific details on the front-end setup.

Back End (Server)

1. Navigate to the Server directory:

   cd Server

2. Install Node.js dependencies:

   npm install

3. Start the server:

   node server.js

Usage

Running Compliance Assessment

1. Ensure all dependencies are installed:

   pip install -r requirements.txt

2. Run the compliance assessment algorithm:

   python assess_compliance.py

Viewing Results

Access the results of the compliance assessment in the generated reports or logs. Take necessary actions based on identified violations and work towards improving data transparency practices.

Contributing

We welcome contributions from the community to make Dark-Patterns even more effective. If you're interested in contributing, please follow our Contribution Guidelines.

Team - Exploit Elits

• Thennavan
• Prathina
• Niranjana V K
• Abhishek J L
• Sudharsan R

Project Overview

For a detailed overview of the project, refer to the Project Overview document.

License

This project is licensed under the MIT License.