anof-cyber / aptrs-react

What is this?

aptrs-react is a React front end to the Automated Penetration Testing Reporting System

Written in TypeScript, this app uses no server resources except to deliver the JavaScript bundle. The back end relies on the APTRS API

Installation

npm install

Note that this will also install a custom build of CK Editor in the /packages/ckeditor director

There is a file called env.example in the root of the project that you will need to customize. Copy it to .env or .env.local and add the API url.

Available Scripts

In the project directory, you can run:

npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

npm test

Launches the test runner in the interactive watch mode.\

npm run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the docs about deployment for more information.