Skip to content

sona-gj/RuntimeTerror-MCCS-FE

Repository files navigation

RuntimeTerror-MCCS-FE

Frontend for the MCCS project, built with React + Vite.
This repo provides the UI layer for the system that generates and manages PDFs using LLMs when provided structured data.


📦 Tech Stack

  • Runtime: Node.js (ESM)
  • Framework: React ^19.1.0
  • Routing: React Router DOM ^7.6.0
  • Bundler/Dev Server: Vite ^6.3.5

Developer Tooling

  • ESLint ^9.25.0 – Linting (flat config)
    • @eslint/js – Core rules
    • eslint-plugin-react-hooks – Hook usage best practices
    • eslint-plugin-react-refresh – Fast Refresh rules
  • EditorConfig – Enforces consistent indentation and line endings across editors
  • VS Code Default Formatter – Auto-format on save with shared settings
  • Type Definitions (@types/react, @types/react-dom)

📂 Project Structure

src/
  App.jsx              # Root component
  main.jsx             # Entry point
  components/          # Reusable UI components
  pages/               # Route-based pages
  hooks/               # Custom React hooks
  context/             # Global state providers (Context API)
  assets/              # Static files (images, icons, etc.)

🔧 Prerequisites

  • Node.js 20+
  • npm

🚀 Setup

Install dependencies:

npm install

Start development server:

npm run dev

Build for production:

npm run build

Preview production build:

npm run preview

🧹 Code Quality

  • Linting

    npm run lint
  • Formatting

    • This project uses the default VS Code formatter.
    • Recommended workspace settings are already provided in .vscode/settings.json.
    • Cross-editor consistency is ensured with .editorconfig.

Example VS Code settings:

{
  "editor.formatOnSave": true,
  "editor.tabSize": 2,
  "editor.insertSpaces": true
}

🖥️ Running

Start dev server:

npm run dev

Visit:

  • http://localhost:5173/ (default Vite dev port)
  • "http://localhost:3000/api"; MCCS Runtime Terror
  • https://www.runtimeterrors.info MCCS Runtime Terror

🧩 Features

  • MCCS Project UI – Interfaces with the backend to manage and display data.
  • PDF Generation Integration – Frontend hooks into the LLM-based backend pipeline for PDF creation.
  • Routing & Context – Provides authenticated routes and state management.
  • Reusable Components – Designed to be extendable for MCCS workflows.

🐳 Docker (optional)

Build and run containerized FE app:

docker build -t mccs-fe .
docker run --rm -p 5173:5173 mccs-fe

📜 Notes

  • This repo is tightly coupled with RuntimeTerror-MCCS-BE.
  • API docs for backend endpoints are maintained separately.
  • Code style: minimal enforcement, relying on VS Code defaults + ESLint checks.
  • Future: can add CI workflows (GitHub Actions) and test runners (Vitest, RTL).

📜 License

MIT © 2025 RuntimeTerror Team

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages