This repository contains the frontend code for the Saferwall threat analysis platform. The Saferwall UI is built with SvelteKit, providing a modern and user-friendly interface for analyzing, triaging, and classifying threats.
The Saferwall UI offers the following features:
- Collaborative environment: Designed to streamline threat analysis, identification, and sharing of malware samples among security teams and researchers.
- Fast and intuitive: Provides a responsive and seamless user experience.
- Open-source first: We are committed to open-source development, prioritizing developer friendliness and user-driven enhancements.
To get started with the Saferwall UI locally, follow these steps:
- Clone this repository:
git clone https://github.com/saferwall/ui.git - Install dependencies:
npm install - Start the development server:
npm run dev
The Saferwall UI will be accessible at http://localhost:5173.
For detailed instructions on deployment options and making changes to the codebase, please refer to the Saferwall Documentation.
The Saferwall UI can be deployed using Cloudflare Pages. The deployment process involves the following steps:
- Configure your Cloudflare Pages settings, such as repository and branch selection.
- Push your code to the repository and trigger a new deployment.
We welcome contributions from the open-source community to enhance the Saferwall UI. If you're interested in contributing, please follow these steps:
- Review our code of conduct
- Fork this repository and create a new branch for your feature or bug fix.
- Make your changes and ensure they adhere to our coding guidelines.
- Commit your changes and push the branch to your forked repository.
- Open a pull request against the
mainbranch of this repository.
We appreciate your contributions and will review your pull request as soon as possible.
If you have any questions or need assistance with the Saferwall UI, please feel free to reach out to us. You can find our contact information and support channels on the Saferwall Discord.
The Saferwall UI is licensed under the Apache License 2.0. Please review the license file for more information.
We would like to express our gratitude to the open-source community for their valuable contributions. Additionally, we acknowledge the following projects and libraries that are used in the Saferwall UI:
- SvelteKit: A powerful framework for building web applications with Svelte.
- Tailwind CSS: A utility-first CSS framework for rapid UI development.
- and other dependencies (refer to package.json for the complete list).
Thank you for choosing Saferwall UI.