Add developer setup guides and update README #2917
Conversation
|
Developer seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account. You have signed the CLA already but the status is still pending? Let us recheck it. |
|
Reveiw task created: https://virtocommerce.atlassian.net/browse/VCST-3364 |
|
|
|
||
| ### Issue 1: "Unable to run your project" (Docker Compose Error) | ||
| **Problem**: Running `dotnet run` from wrong directory shows Docker Compose error | ||
| **Cause**: VirtoCommerce has multiple projects; running from root triggers Docker Compose mode |
There was a problem hiding this comment.
Virto Commerce Platform has multiple projects...
There was a problem hiding this comment.
This one is for proper LLM index, otherwise it will mix up folders to run from
| 2. **Configure backend connection:** | ||
| ```bash | ||
| # Create .env file with correct backend URL | ||
| echo APP_BACKEND_URL=http://localhost:10645 > .env |
There was a problem hiding this comment.
Using .env.local is better
| ```bash | ||
| # Find and kill the process using the port | ||
| netstat -ano | findstr ":10645" | ||
| Stop-Process -Id <ProcessId> -Force |
There was a problem hiding this comment.
Stop-Process is a PowerShell command, so probably you should replace bash with powershell everywhere
| ``` | ||
|
|
||
| **Option B: Local SQL Server** | ||
| Update `appsettings.Development.json`: |
There was a problem hiding this comment.
Changing platform files is not recommended. Instead, you should use user secrets or environment variables.
| # Copy built files | ||
| Copy-Item "src\VirtoCommerce.McpServer.Web\bin\Debug\net8.0\*" "D:\work\vc-platform\modules\VirtoCommerce.McpServer" -Recurse -Force | ||
|
|
||
| # Copy essential module files | ||
| Copy-Item "src\VirtoCommerce.McpServer.Web\module.manifest" "D:\work\vc-platform\modules\VirtoCommerce.McpServer\" -Force | ||
| New-Item -ItemType Directory -Path "D:\work\vc-platform\modules\VirtoCommerce.McpServer\Scripts" -Force | ||
| Copy-Item "src\VirtoCommerce.McpServer.Web\Scripts\*" "D:\work\vc-platform\modules\VirtoCommerce.McpServer\Scripts\" -Recurse -Force |
There was a problem hiding this comment.
This is too complicated. A better way is cloning right into vc-platform\modules or creating a link with mklink
Summary
This PR adds comprehensive setup guides for developers working with VirtoCommerce:
Benefits
Image tag:
ghcr.io/VirtoCommerce/platform:3.890.0-pr-2917-db2f-add-developer-setup-guides-db2fbfa6