From 3a9dc565599b074df15c7c251348236917688964 Mon Sep 17 00:00:00 2001 From: GitHub Copilot Date: Tue, 6 May 2025 12:24:07 +0000 Subject: [PATCH] Refine development environment setup instructions in README.md --- README.md | 60 ++++++++++--------------------------------------------- 1 file changed, 11 insertions(+), 49 deletions(-) diff --git a/README.md b/README.md index 45f5b09..89a547b 100644 --- a/README.md +++ b/README.md @@ -15,21 +15,19 @@ This app is currently deployed using Cloudflare Pages. The logs can be viewed wi ## Development Environment Setup -For detailed setup instructions, including container building, environment configuration, and troubleshooting, see [ENVIRONMENT_SETUP.md](ENVIRONMENT_SETUP.md). +For detailed setup instructions, including container building, environment configuration, authentication, and troubleshooting, see [ENVIRONMENT_SETUP.md](ENVIRONMENT_SETUP.md). -### GitHub MCP Server -The project uses GitHub's MCP server for development tasks. The server runs in a Docker container and is automatically configured when you open the project in a devcontainer. +### Quick Start -#### Configuration -- The MCP server uses GitHub authentication via Personal Access Token -- Token is stored securely in `.devcontainer/.env` (not committed to repository) -- GitHub CLI is installed in the devcontainer for easier authentication management -- Container health monitoring is configured +1. **Prerequisites** + - Docker Desktop installed and running + - VS Code with Remote - Containers extension + - GitHub account with Personal Access Token (PAT) -#### Usage -The MCP server will automatically start when you open the project in a devcontainer. If you need to manually authenticate: -1. Run `gh auth login` in the terminal -2. Follow the prompts to authenticate with your GitHub account +2. **Setup Steps** + - Clone this repository + - Copy `.devcontainer/.env.example` to `.devcontainer/.env` and add your GitHub PAT + - Open in VS Code and select "Reopen in Container" when prompted ### Database Setup @@ -77,40 +75,4 @@ import type { Transaction } from '@types'; // ❌ DON'T use relative imports like this import { transactionService } from '../../../../data/db.service'; -``` - -## Development Container Setup - -### GitHub Personal Access Token -Before using the development container, you'll need a GitHub Personal Access Token (PAT) with the following permissions: -- `repo` (Full control of private repositories) -- `read:packages` (Download container images) -- `write:packages` (Upload container images) -- `delete:packages` (Optional: manage container versions) -- `workflow` (GitHub Actions integration) - -### Using the Development Container - -#### Command Line Interface -You can build and start the development container using the devcontainer CLI: - -```bash -# Build the container -devcontainer build . - -# Start the container (with post-create command) -devcontainer up --workspace-folder . - -# Start the container (skip post-create) -devcontainer up --workspace-folder . --skip-post-create -``` - -#### VS Code -1. Open the project in VS Code -2. Press F1 and run "Dev Containers: Rebuild and Reopen in Container" - - To skip post-create steps: Press F1 and run "Dev Containers: Rebuild Container Without Cache" - -### Troubleshooting -- If GitHub authentication fails, ensure your PAT is correctly set in `.devcontainer/.env` -- For network issues, try rebuilding the container with `--no-cache` option -- Check the VS Code "Dev Containers" output panel for detailed logs \ No newline at end of file +``` \ No newline at end of file