Skip to content

Add comprehensive SETUP.md guide for new users - #2

Draft
simoncht with Copilot wants to merge 2 commits into
mainfrom
copilot/setup-new-machine-instructions
Draft

Add comprehensive SETUP.md guide for new users#2
simoncht with Copilot wants to merge 2 commits into
mainfrom
copilot/setup-new-machine-instructions

Conversation

Copilot AI commented Dec 18, 2025

Copy link
Copy Markdown

User requested step-by-step guidance for setting up the project on a new machine, specifically for those new to GitHub.

Changes

  • New SETUP.md — Complete beginner-friendly setup guide covering:

    • Prerequisites (OS, RAM, disk space requirements)
    • Software installation (Git, Docker Desktop, Node.js) with platform-specific instructions for Windows/macOS/Linux
    • Repository cloning and environment configuration
    • Docker Compose startup and service overview
    • Database migrations and frontend setup
    • Verification steps and troubleshooting common issues
    • Daily workflow commands
  • Updated README.md — Added prominent "Getting Started" section linking to SETUP.md and updated Documentation section to list it first

Original prompt

just an fyi. how do i setup a new machine to download this code and start running locally on it? i am new to github and step by step guidance is requried.


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Copilot AI self-assigned this Dec 18, 2025
…eferences

Co-authored-by: simoncht <26563742+simoncht@users.noreply.github.com>
Copilot AI changed the title [WIP] Add setup instructions for new machine Add comprehensive SETUP.md guide for new users Dec 18, 2025
Copilot AI requested a review from simoncht December 18, 2025 04:50
@simoncht

Copy link
Copy Markdown
Owner

@copilot start this application.

Copilot AI commented Dec 18, 2025

Copy link
Copy Markdown
Author

@copilot start this application.

I attempted to start the application using docker compose up -d, but the Docker build is failing due to SSL certificate verification issues in this sandbox environment (cannot reach pypi.org to download Python packages). This is an infrastructure limitation of the CI environment, not an issue with the application code.

To run this application on your local machine, follow the steps in the SETUP.md guide:

  1. Install Docker Desktop, Git, and Node.js
  2. Clone the repository: git clone https://github.com/simoncht/rag-transcript.git
  3. Navigate to the project: cd rag-transcript
  4. Start backend: docker compose up -d
  5. Run migrations: docker compose exec app alembic upgrade head
  6. Start frontend: cd frontend && npm install && npm run dev
  7. Access at http://localhost:3000

The application should build and run successfully on a standard development machine with proper internet access.

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.

2 participants