|
1 | | -This is a new [**React Native**](https://reactnative.dev) project, bootstrapped using [`@react-native-community/cli`](https://github.com/react-native-community/cli). |
| 1 | + |
2 | 2 |
|
3 | | -# Getting Started |
| 3 | +# freeMalwareDetection for React Native |
4 | 4 |
|
5 | | ->**Note**: Make sure you have completed the [React Native - Environment Setup](https://reactnative.dev/docs/environment-setup) instructions till "Creating a new application" step, before proceeding. |
| 5 | +Enhance the security of your Android application with Free Malware Detection, a powerful feature designed to scan for malicious or suspicious apps. Leveraging various blacklists and security policies, this tool ensures your application remains protected from known threats, providing a secure environment for your users. |
6 | 6 |
|
7 | | -## Step 1: Start the Metro Server |
| 7 | +## Overview |
8 | 8 |
|
9 | | -First, you will need to start **Metro**, the JavaScript _bundler_ that ships _with_ React Native. |
| 9 | +freeMalwareDetection is an easy-to-integrate SDK that operates asynchronously to safeguard your application without compromising performance. It runs scans in the background, ensuring that your app's performance remains unaffected while delivering comprehensive security checks. This SDK is freely available and designed for seamless integration with the freeRASP SDK, delivering a comprehensive security solution. |
10 | 10 |
|
11 | | -To start Metro, run the following command from the _root_ of your React Native project: |
| 11 | +## Key Advantages |
12 | 12 |
|
13 | | -```bash |
14 | | -# using npm |
15 | | -npm start |
| 13 | +- **Asynchronous Scanning**: Perform malware scans in the background without impacting app performance. |
| 14 | +- **Threat Analysis**: Receive information about detected threats to better inform and protect your users. |
| 15 | +- **Simple Integration**: Easy-to-follow integration process with extensive documentation and support. |
| 16 | +- **Versatile Blacklisting**: Supports hash-based, package name-based, and permission-based blacklists for comprehensive threat detection. |
| 17 | +- **Seamless Operation**: Integrates smoothly with freeRASP SDK to provide an all-in-one security solution. |
16 | 18 |
|
17 | | -# OR using Yarn |
18 | | -yarn start |
19 | | -``` |
| 19 | +## 🎯 Features |
20 | 20 |
|
21 | | -## Step 2: Start your Application |
| 21 | +Free Malware Detection provides protection against potentially dangerous applications and behaviors, including: |
22 | 22 |
|
23 | | -Let Metro Bundler run in its _own_ terminal. Open a _new_ terminal from the _root_ of your React Native project. Run the following command to start your _Android_ or _iOS_ app: |
| 23 | +✔️ Detection of apps with suspicious package names or hashes. |
24 | 24 |
|
25 | | -### For Android |
| 25 | +✔️ Blocking of apps with disallowed permissions. |
26 | 26 |
|
27 | | -```bash |
28 | | -# using npm |
29 | | -npm run android |
| 27 | +✔️ Whitelisting of trusted installation sources to prevent unauthorized app installations. |
30 | 28 |
|
31 | | -# OR using Yarn |
32 | | -yarn android |
33 | | -``` |
| 29 | +Visit our wiki to learn more about the specific checks performed and their impact on app security. |
34 | 30 |
|
35 | | -### For iOS |
| 31 | +## 📖 Discover Official Documentation |
36 | 32 |
|
37 | | -```bash |
38 | | -# using npm |
39 | | -npm run ios |
| 33 | +Explore our [GitBook page](https://docs.talsec.app/freemalwaredetection) for detailed guides, tutorials, and technical documentation. |
40 | 34 |
|
41 | | -# OR using Yarn |
42 | | -yarn ios |
43 | | -``` |
| 35 | +## 🔗 Integration Guide |
44 | 36 |
|
45 | | -If everything is set up _correctly_, you should see your new app running in your _Android Emulator_ or _iOS Simulator_ shortly provided you have set up your emulator/simulator correctly. |
| 37 | +To integrate Free Malware Detection, follow our step-by-step [Integration Guide](https://docs.talsec.app/freemalwaredetection/integration-guide/requirements). This guide provides all the details you need for a smooth setup process on any platform. |
46 | 38 |
|
47 | | -This is one way to run your app — you can also run it directly from within Android Studio and Xcode respectively. |
| 39 | +## ✨ Enhancements |
48 | 40 |
|
49 | | -## Step 3: Modifying your App |
| 41 | +If you have any suggestions for improvement or notice anything that could be clarified in the new documentation, please open an issue. Your feedback helps us maintain high-quality resources for all users. |
50 | 42 |
|
51 | | -Now that you have successfully run the app, let's modify it. |
| 43 | +You can check out the [project board](https://github.com/orgs/talsec/projects/3) here. |
52 | 44 |
|
53 | | -1. Open `App.tsx` in your text editor of choice and edit some lines. |
54 | | -2. For **Android**: Press the <kbd>R</kbd> key twice or select **"Reload"** from the **Developer Menu** (<kbd>Ctrl</kbd> + <kbd>M</kbd> (on Window and Linux) or <kbd>Cmd ⌘</kbd> + <kbd>M</kbd> (on macOS)) to see your changes! |
55 | | - |
56 | | - For **iOS**: Hit <kbd>Cmd ⌘</kbd> + <kbd>R</kbd> in your iOS Simulator to reload the app and see your changes! |
57 | | - |
58 | | -## Congratulations! :tada: |
59 | | - |
60 | | -You've successfully run and modified your React Native App. :partying_face: |
61 | | - |
62 | | -### Now what? |
63 | | - |
64 | | -- If you want to add this new React Native code to an existing application, check out the [Integration guide](https://reactnative.dev/docs/integration-with-existing-apps). |
65 | | -- If you're curious to learn more about React Native, check out the [Introduction to React Native](https://reactnative.dev/docs/getting-started). |
66 | | - |
67 | | -# Troubleshooting |
68 | | - |
69 | | -If you can't get this to work, see the [Troubleshooting](https://reactnative.dev/docs/troubleshooting) page. |
70 | | - |
71 | | -# Learn More |
72 | | - |
73 | | -To learn more about React Native, take a look at the following resources: |
74 | | - |
75 | | -- [React Native Website](https://reactnative.dev) - learn more about React Native. |
76 | | -- [Getting Started](https://reactnative.dev/docs/environment-setup) - an **overview** of React Native and how setup your environment. |
77 | | -- [Learn the Basics](https://reactnative.dev/docs/getting-started) - a **guided tour** of the React Native **basics**. |
78 | | -- [Blog](https://reactnative.dev/blog) - read the latest official React Native **Blog** posts. |
79 | | -- [`@facebook/react-native`](https://github.com/facebook/react-native) - the Open Source; GitHub **repository** for React Native. |
| 45 | +## :page_facing_up: License |
| 46 | +This project is provided as freemium software, i.e. there is a fair usage policy that imposes some limitations on the free usage. The SDK software consists of open-source and binary parts, which is the property of Talsec. The open-source part is licensed under the MIT License - see the LICENSE file for details. |
0 commit comments