This VS Code extension provides seamless integration with the Prestige AI platform, enhancing your development workflow for projects hosted on GitHub Codespaces and locally. It streamlines project management, terminal access, and synchronization between your local environment, Codespaces, and the Prestige AI server.
Features
Project Management: View, create, and manage your Prestige AI projects directly within VS Code.
Codespace Integration: Easily create, start, stop, and manage GitHub Codespaces for your projects.
Terminal Management: Open, manage, and share terminal sessions within your Codespaces.
File Synchronization: Keep your local workspace, Codespace, and Prestige AI project files synchronized. Automatic conflict resolution is built in, and manual resolution options are available when needed.
Deployment: Deploy your projects with a single click.
Getting Started
Prerequisites:
Node.js and npm (or yarn) installed. (Version 12 or higher recommended).
VS Code installed.
Git installed and configured.
A GitHub account.
Prestige AI Server: You MUST have a running instance of the Prestige AI server. The default configuration assumes the server is running locally at http://localhost:5000. Adjust the prestige.serverUrl setting in VS Code if necessary. The server's API endpoints must be functional. The authentication system relies on server-side functions for proper operation.
simple-git: Run npm install simple-git
1. Clone the Repository:
git clone https://github.com/United-Visions/prestige-codespace-extension.git
cd prestige-codespace-extension
Use code with caution.
Markdown
2. Install Dependencies:
npm install
Use code with caution.
Bash
3. Build the Extension:
npm run build
Use code with caution.
Bash
This will generate the necessary files in the dist directory.
4. Run the Extension Locally (for Testing):
Open VS Code.
Press Ctrl+Shift+P (or Cmd+Shift+P on macOS).
Select "Install from VSIX".
Choose the *.vsix file in the dist folder.
5. Configure VS Code:
Create a settings.json file in your VS Code workspace (.vscode/.settings.json if you have a workspace open, or in your VS Code user settings):
{
"prestige.serverUrl": "http://localhost:5000" // Adjust if your Prestige server is on a different address
}
Use code with caution.
Json
For easier testing of the workflow, you might temporarily add your authToken here to skip the initial login. Remove or comment this for actual production use.
{
"prestige.serverUrl": "http://localhost:5000",
"prestige.secrets": {
"authToken": "YOUR_AUTH_TOKEN" //REPLACE with a valid token for testing purposes only!
}
}
Use code with caution.
Json
6. Testing:
Open a folder in VS Code containing sample project files. The extension should now be active, and you can interact with it using the commands defined in package.json.
Deployment to the VS Code Marketplace
Prerequisites for Marketplace Deployment:
A VS Code publisher account.
Your extension code is ready and thoroughly tested.
Update your package.json's description and version to reflect the latest state.
Steps:
VSIX Packaging: Create the VSIX file using:
npm run package
Use code with caution.
Bash
VS Code Publisher Account: Log in to your VS Code publisher account using the command line:
vsce login
Use code with caution.
Bash
You'll be prompted to provide your credentials.
Publish the Extension: Publish your extension to the marketplace:
vsce publish
Use code with caution.
Bash
Remember to increment the version number in your package.json before each publish to the marketplace. Thoroughly test your extension before publishing to ensure a smooth user experience.
Contributing
Contributions are welcome! Please open an issue or submit a pull request.
License
MIT License
