Skip to content

cyclopt/community-tdd

Repository files navigation

Cyclopt Companion

Welcome to Technical Due Diligence 👋

A web application interface for generating Technical Due Diligence Reports of the provided software.

🧩 Features

  • 📂 Code Upload
    Upload your project’s source code for security/maintainability analysis.

  • 📑 Report Generation
    Download reports (PDF) with code scan results.

🛠️ Prerequisites

Make sure you have installed:

🚀 Getting Started

1. Clone repository

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

2. Install dependencies

npm install

3. Set up environment variables

Create a .env file and store based on .env.sample and fill in your values:

  • VITE_MAIN_SERVER_URL – URL of the backend API (Required) (check the Cyclopt Community Server)
  • VITE_SENTRY_ENVIRONMENT – Sentry environment (Optional)
  • VITE_SENTRY_DSN – Public DSN for Sentry (Optional)

▶️ Running the App

1. Configure and start backend server

2. Start frontend React app

npm run dev

🧪 Testing

Run lint tests

npm test

Test production build:

npm run build && npm run preview

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published