ConexoLA/RAWRR

RAWRR is a multiplatform app that assists with note taking and report generation for security evaluations.

---

To install the packages that will allow you to modify RAWRR or, in the other case, to build the executable, please follow these steps:

1. Select the base directory in which you want to download RAWRR.

   # Modify the working directory
   cd path/to/working/directory

---

Optional
If you need to create the directory you can easily run mkdir path/to/working/directory

---

2. Clone our RAWRR repository.

   # Cloning base repository
   git clone https://github.com/ConexoLA/RAWRR.git

3. Install dependencies

Depending on the usage you want to give to RAWRR, you may modify the code using the hot-reload functionality or generate the executable by building the project.

In both cases, you must install all the packages available in package.json.

# install packages from package.json
npm install

Fixing vulnerabilites

Sometimes, security vulnerabilities are found and updates are available. Below, we show an example:

In most cases, we encourage the user to run the comman npm audit fix

The usual output of this command is as follows:

fixed X of Y vulnerabilities in Z scanned packages
Y-X vulnerabilities required manual review and could not be updated

Where:

1. X is the number of vulnerabilties solved.
2. Y was the total number of vulnerabilities to be solved.
3. Z is the number of packages that were scanned
4. Y-X is the number of vulnerabilities that should be solved manually.

---

Information
At this point you could:

1. Modify RAWRR in the case you want to add new functionalities or extend RAWRR. Once you finish your changes, go to step 2.
2. Generate the executable of RAWRR.

---

Modify RAWRR using electron

If you want to modify RAWRR using the hot reaload option from electron, you can use the following command:

npm run electron:serve

This command, will start a development server to test your application (as you can see in the image below).

After the server is launched, you will realize the application is being tested in development mode because the usual tools for developers are activated:

Create the RAWRR executable

If you want to generate the executable of RAWRR for your current OS, run:

# Creates a build targeting the current OS
npm run electron:build

---

If you want to generate the executable of RAWRR for a platform that's different from your current OS:

1. For each platform you want to create a build, run the following command:

   # Line breaks are just to provide clarity, you have to remove them prior to execution
   ./node_modules/.bin/node-pre-gyp install
   --directory=./node_modules/sqlite3
   --target_platform={OS}
   --target_arch={OS architecture}
   --target={Node version}

   For example:

   • Linux x64 and Node 15.14.0:

     ./node_modules/.bin/node-pre-gyp install --directory=./node_modules/sqlite3 --target_platform=linux --target_arch=x64 --target=15.14.0

   • Mac x64 and Node 15.14.0:

     ./node_modules/.bin/node-pre-gyp install --directory=./node_modules/sqlite3 --target_platform=darwin --target_arch=x64 --target=15.14.0

   • Windows x86 and Node 15.14.0:

     ./node_modules/.bin/node-pre-gyp install --directory=./node_modules/sqlite3 --target_platform=win32 --target_arch=x86 --target=15.14.0

2. Create your build(s) with one or a combination of the following:

   # Linux, Windows and Mac
   npm run electron:build:all
   
   # Linux
   npm run electron:build:linux
   
   # Windows
   npm run electron:build:windows
   
   # Mac
   npm run electron:build:mac

Run your tests

npm run test

Lints and fixes files

npm run lint

Customize configuration

See Configuration Reference.

Feedback

You can submit your feedback via email at rawrr@conexo.org.