Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

design and implement website describing capa and showing the available rules #1550

Closed
7 of 10 tasks
williballenthin opened this issue Jun 15, 2023 · 1 comment · Fixed by #2310
Closed
7 of 10 tasks
Labels
rule website related to rule content web visualization

Comments

@williballenthin
Copy link
Collaborator

williballenthin commented Jun 15, 2023

We'd like to have a homepage for capa that describes the tool, exposes the current rule set, and provides other features. We can deploy the website via Github Actions to Github Pages, which would result in the url: https://mandiant.github.io/capa

related/duplicate of: mandiant/capa-rules#664

Tasks

  1. rule website
  2. rule website
  3. rule website
    DeeyaSingh
  4. rule website
    DeeyaSingh
  5. rule website
  6. rule website
  7. rule website

The objective of this project is to develop a website for the Capa project, which will serve as the official online platform for Capa users and contributors. The website will be hosted on GitHub Pages as static content but will incorporate interactive JavaScript features. The key features of the website include a homepage for the Capa project, a rule browsing section with canonical URLs for referencing rules, and the ability to search rules by metadata and features. Additionally, there will be optional features to demonstrate the output of Capa via xterm.js and enable running Capa in the browser using Pyodide.

@williballenthin williballenthin added the rule website related to rule content web visualization label Jun 15, 2023
@ghost
Copy link

ghost commented Jun 15, 2023

Specifications by @DeeyaSingh:

Homepage:

The homepage features a clean and modern design with the capa project logo and a brief introduction to Capa's capabilities.
It includes a prominent call-to-action button inviting users to explore the rule library.

Rule Browsing:

The rule browsing section provides a grid or list view of available rules.
Each rule card displays the rule's name, a short description, and metadata such as author and date of creation.
Users can click on a rule card to view the rule details.

Rule Details:

The rule details page presents comprehensive information about a specific rule.
The top section includes the rule's name, description, and metadata.
The middle section provides a more detailed explanation of the rule's purpose, behavior, and detection logic.
The bottom section may include example code snippets or screenshots illustrating the rule's application.

Search and Filter:

The website includes a search bar at the top for users to search for rules by keywords or metadata.
Users can also use filters to narrow down the rule list based on specific criteria such as rule type or category (If necessary)

Interactive Demo:

The website offers an interactive demo where users can upload a file or paste its content for analysis.
Upon analysis, the demo displays the matched rules and their results in a user-friendly format.

Navigation and Layout:

The website has a fixed navigation bar at the top, allowing easy access to different sections of the site.
The layout is responsive, ensuring the website adapts to different screen sizes and devices.
Consistent styling, typography, and color schemes are used throughout the website for a cohesive and professional look.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
rule website related to rule content web visualization
Projects
Development

Successfully merging a pull request may close this issue.

1 participant