community-tdd

Technical Due Diligence Web Application

Technical Due Diligence is a comprehensive web application designed to streamline the process of generating Technical Due Diligence Reports for software projects. This user-friendly interface facilitates the assessment of any provided software by enabling efficient code analysis and report generation.

Key Features

• Code Upload
  Users can easily upload their project's source code, allowing for an in-depth security and maintainability analysis.

• Report Generation
  After the code scan is complete, users can download detailed reports in PDF format, summarizing the findings and insights regarding the codebase.

Prerequisites

To utilize this application, certain prerequisites must be met:

• Node.js (version 20 or higher)
• npm (Node package manager)

Getting Started

Clone the repository and install the necessary dependencies to get started:

git clone https://github.com/cyclopt/community-tdd.git
cd community-tdd
npm install

Set up the required environment variables in a .env file, using .env.sample as a reference:

• VITE_MAIN_SERVER_URL (required) - The URL of the backend API. Refer to the Cyclopt Community Server for details.
• VITE_SENTRY_ENVIRONMENT (optional) - The Sentry environment.
• VITE_SENTRY_DSN (optional) - The public DSN for Sentry.

Running the Application

To configure and start the backend server, follow the necessary setup instructions. Once the backend is ready, start the frontend React app with the following command:

npm run dev

Testing

Ensure the quality of the application by running lint tests:

npm test

For testing the production build, use the following commands:

npm run build && npm run preview

Technical Due Diligence helps developers and organizations assess their software projects effectively, promoting better security and maintainability through structured reports.