mirror of
https://github.com/acedanger/finance.git
synced 2025-12-05 22:50:12 -08:00
Configure GitHub MCP server in devcontainer environment (Closes #25)
This commit is contained in:
31
README.md
31
README.md
@@ -11,4 +11,33 @@ A web application for managing financial transactions across multiple bank accou
|
||||
* **Key Features (Implemented & Planned):** Account switching, transaction listing, adding, editing, and deleting transactions.
|
||||
|
||||
## Logs
|
||||
This app is currently deployed using Cloudflare Pages. The logs can be viewed with the `npx wrangler pages deployment tail --project-name finance` command. T
|
||||
This app is currently deployed using Cloudflare Pages. The logs can be viewed with the `npx wrangler pages deployment tail --project-name finance` command.
|
||||
|
||||
## Development Environment Setup
|
||||
|
||||
### Prerequisites
|
||||
- VS Code with Remote Containers extension
|
||||
- Docker and Docker Compose
|
||||
- Git
|
||||
|
||||
### Initial Setup
|
||||
1. Clone the repository
|
||||
2. Copy `.devcontainer/.env.example` to `.devcontainer/.env`
|
||||
3. Update the environment variables in `.devcontainer/.env`
|
||||
4. Open the project in VS Code and select "Reopen in Container" when prompted
|
||||
|
||||
### 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.
|
||||
|
||||
#### 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
|
||||
|
||||
#### 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
|
||||
|
||||
### Database Setup
|
||||
Reference in New Issue
Block a user