Skip to content

How to Use SSIND from Git

Irfannur Diah edited this page May 25, 2023 · 1 revision

Prerequisites

Before getting started with SSIND, make sure you have the following prerequisites:

  • Python 3.x installed on your system
  • Chrome browser installed
  • ChromeDriver executable file (compatible with your Chrome browser version) placed in the appropriate location

Installation

  1. Clone the SSIND repository from GitHub:

    git clone https://github.com/irfnrdh/ssind.git

  2. Navigate to the project directory:

    cd ssind

  3. Install the required dependencies using pip:

    pip install -r requirements.txt

Configuration

  1. Open the websites.json file located in the config directory.

  2. Modify the file to define the list of websites you want to capture screenshots from. Each website should have the following properties:

    • "name": The name or identifier for the website.
    • "url": The URL of the website.
    • "screenshot": A placeholder for the screenshot path (this will be updated automatically).
  3. (Optional) If you want to use custom mockups for the screenshots, create mockup images and place them in the mockups directory. Make sure the mockup images match the screen size/resolution you want to capture.

  4. (Optional) If you want to use different devices or screen resolutions for capturing screenshots, modify the devices.json file located in the mockups directory. The file contains a list of devices with their platform, name, width, height, and corresponding mockup file name.

Usage

To capture screenshots using SSIND, follow these steps:

  1. Open a terminal or command prompt.

  2. Navigate to the SSIND project directory:

    cd SSIND

  3. Run the SSIND toolkit:

    python SSIND.py

  4. SSIND will start capturing screenshots from the configured websites. The progress will be displayed in the terminal.

  5. Once the screenshot capture is complete, you can find the screenshots in the screenshots directory. The screenshots will be organized in subdirectories based on website name and timestamp.

  6. (Optional) To generate a PDF report of the captured screenshots, use the --report flag:

    python ssind.py --report

    The PDF report will be generated in the project directory as report.pdf.

Additional Options

  • --clear: Use this flag to clear the screenshots folder before capturing new screenshots. This is useful when you want to start fresh with a clean folder.

    python ssind.py --clear

  • --config <config_file>: Use this option to specify a different configuration file. By default, SSIND uses websites.json as the configuration file.

    python ssind.py --config custom_config.json

Conclusion

With the SSIND (ScreenShot-Ind) toolkit, capturing unlimited screenshots from a list of websites has never been easier. Follow the steps outlined above to configure and use SSIND effectively in your web development, design, or quality assurance workflow. Enjoy seamless website monitoring and comprehensive report generation with SSIND!

Clone this wiki locally