This document provides an overview of common development tools and utility scripts used in the LCFS project. This is part of the requirements for ticket #2410.

• Purpose: Dependency management and packaging for Python projects.
• Configuration: backend/pyproject.toml, backend/poetry.lock.
• Common Commands (run from backend/ directory):
  • poetry install: Install dependencies.
  • poetry add <package_name>: Add a new dependency.
  • poetry remove <package_name>: Remove a dependency.
  • poetry update: Update dependencies to their latest allowed versions.
  • poetry run <command>: Run a command within the project's virtual environment (e.g., poetry run pytest).
• Reference: Poetry Documentation

• Purpose: A framework for managing and maintaining multi-language pre-commit hooks. Ensures code quality checks (linting, formatting) run before code is committed.
• Configuration: backend/.pre-commit-config.yaml.
• Hooks Used: Black (formatter), Flake8 (linter), Isort (import sorter), MyPy (static type checker), wemake-python-styleguide (linter).
• Setup (run from backend/ directory):

  poetry run pre-commit install

• Usage: Runs automatically when you git commit. You can also run it manually on all files: poetry run pre-commit run --all-files.
• Reference: Pre-commit Documentation

• Purpose: Utility script in backend/migrate.sh for managing Alembic database migrations.
• Functionality: Generating new migration scripts, applying upgrades, and performing downgrades.
• Usage: See Database Schema Overview.

• Purpose: Load testing tool for backend APIs.
• Configuration: backend/performance/locustfile.py defines test scenarios.
• Usage: See backend/performance/readme.md for instructions on running load tests.
• Reference: Locust Documentation

• Purpose: Node.js is the JavaScript runtime. npm (Node Package Manager) is used for managing frontend dependencies and running scripts.
• Configuration: frontend/package.json, frontend/package-lock.json.
• Common Commands (run from frontend/ directory):
  • npm install: Install dependencies.
  • npm run dev: Start the Vite development server.
  • npm run build: Create a production build.
  • npm run test: Run Vitest unit tests.
  • npm run lint: Run ESLint.
  • npm run cypress:open: Open Cypress test runner.
• Reference: Node.js Documentation, npm Documentation

• Purpose: Frontend build tool and development server. Provides fast HMR and optimized builds.
• Configuration: frontend/vite.config.js.
• Reference: Vite Documentation

• Purpose: Pluggable JavaScript linter to find and fix problems in JavaScript code.
• Configuration: frontend/.eslintrc.cjs.
• Usage: Integrated into pre-commit hooks (via Husky) and can be run manually: npm run lint.
• Reference: ESLint Documentation

• Purpose: Opinionated code formatter.
• Configuration: frontend/.prettierrc.
• Usage: Integrated into pre-commit hooks (via Husky) and can be run manually.
• Reference: Prettier Documentation

• Purpose: Tool for managing Git hooks easily (e.g., for running linters/formatters on pre-commit).
• Configuration: frontend/.husky/ directory.
• Setup: Typically installed via npm install if listed as a dev dependency.
• Reference: Husky Documentation

• Purpose: UI component development environment and documentation tool. Allows developing and testing components in isolation.
• Configuration: frontend/.storybook/ directory.
• Run: npm run storybook (from frontend/ directory).
• Reference: Storybook Documentation

• cypress.env.json: Stores environment variables for Cypress tests (e.g., user credentials). Create from cypress.env.example.json. Do not commit cypress.env.json.
• Chrome Recorder: Potentially used for generating Cypress test skeletons (see frontend/cypress/chrome-recorder if present).

• Purpose: Data flow automation and version control for flows.
• Local Setup: Managed via etl/docker-compose.yml.
• Access UIs (local dev):
  • NiFi: http://localhost:8091/nifi/
  • NiFi Registry: http://localhost:18080

• Purpose: Script to automate NiFi-based data migration from TFRS to LCFS.
• Usage: See Data Migration (TFRS to LCFS).

• Purpose: Script to transfer database dumps between OpenShift and local PostgreSQL instances.
• Usage: See Data Migration (TFRS to LCFS).

• jq: Command-line JSON processor, used by ETL scripts.
• lsof: Utility to list open files, used by ETL scripts to check port usage.
• Installation: These may need to be installed on your system if not already present, especially if you are running ETL scripts locally outside of a container that might provide them.

• Docker & Docker Compose: For containerization and local orchestration across the project.
• Git & GitHub: For version control and collaboration.
• OpenShift CLI (oc): For interacting with OpenShift clusters.
• IDE: VS Code is popular, but other IDEs supporting Python and JavaScript development can be used.

---

This list provides an overview. Refer to the specific documentation for each tool for more detailed information and advanced usage.