mirror of
https://github.com/acedanger/finance.git
synced 2025-12-05 22:50:12 -08:00
docs: add development container setup instructions (#29)
- Add PAT requirements - Add devcontainer CLI commands - Add VS Code instructions - Add troubleshooting tips Part of #29
This commit is contained in:
38
README.md
38
README.md
@@ -40,4 +40,40 @@ The MCP server will automatically start when you open the project in a devcontai
|
||||
1. Run `gh auth login` in the terminal
|
||||
2. Follow the prompts to authenticate with your GitHub account
|
||||
|
||||
### Database Setup
|
||||
### Database Setup
|
||||
|
||||
## 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
|
||||
Reference in New Issue
Block a user