Skip to content

Add Terragon setup script for development environment initialization - #1

Draft
Roystbeef wants to merge 1 commit into
masterfrom
terragon/setup-codebase-environment
Draft

Add Terragon setup script for development environment initialization#1
Roystbeef wants to merge 1 commit into
masterfrom
terragon/setup-codebase-environment

Conversation

@Roystbeef

Copy link
Copy Markdown
Owner

Summary

  • Introduces a new setup script terragon-setup.sh to prepare the Terragon codebase for development
  • Validates project structure and required files
  • Checks for essential dependencies like Python3 and Git
  • Provides guidance for starting a local development server

Changes

Setup Script

  • terragon-setup.sh: Bash script that:
    • Ensures it is run from the project root by checking for index.html
    • Verifies presence of required files (index.html, css/styles.css, js/main.js, README.md)
    • Checks for Python3 installation and Git availability
    • Confirms if the project is a Git repository and shows current branch
    • Provides instructions to start a local development server using Python3
    • Offers development tips and project overview

Test plan

  • Run the script from the project root and verify all checks pass
  • Confirm error messages appear when required files or dependencies are missing
  • Validate instructions for starting the development server are clear and accurate
  • Ensure script exits on errors to prevent partial setup

This script streamlines the initial setup process for developers, ensuring a consistent environment and reducing setup errors.

🌿 Generated by Terry


ℹ️ Tag @terragon-labs to ask questions and address PR feedback

📎 Task: https://www.terragonlabs.com/task/12760a0f-10bf-46bf-a8ba-4dad53696328

Add a new bash script `terragon-setup.sh` to automate the setup of the Terragon codebase for development. The script verifies the project structure, checks for required dependencies like Python3 and git, ensures all necessary files are present, and provides instructions for starting the development server and editing the project files. This improves the onboarding experience for developers.

Co-authored-by: terragon-labs[bot] <terragon-labs[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant