Git Product home page Git Product logo

sfcc-vscode-remote's Introduction

Project Support

If you or your company enjoy using this project, please consider supporting my work and joining my discord. 💖

Become a GitHub Sponsor Become a Patreon Sponsor Donate via PayPal Join Discord Community


Logo

SFCC › VS Code › Remote Development Container

VS Code Remote Development Container for SFCC Teams as Recommended by Salesforce.

Created for SFCC Developers by SFCC Developers:

  • Cross-Platform Virtual Environment for SFCC Developers
  • Customized VS Code with Your Teams Settings & Extensions
  • Pair Programming and Audio Chat for Entire Team
  • Run Custom DevOps Scripts directly in VS Code
  • Customizable Environmental Dotfiles

Get Started

Not your first time here?

Get Started

Demo Video

Want a quick walkthough on how to use our Remote Container?

Play Demo Video

Getting Started

Organization Setup

  1. Repository Setup

Developer Setup

  1. Prerequisites
  2. Git Credentials
  3. Usage Instructions

If you got stuck along the way, checkout our Troubleshooting document.

Troubleshooting

Benefits

Remote Container is Version Controlled

This means you can Version Control your teams Dev Environment.

Need to work on updating to a new version of Node? Need to update your Team's Linter or Code Formatting Rules? Maybe you want to try out a new VS Code Extension with your entire Team? No problem! Make a branch, change some settings in the container config, and VS Code will prompt anyone switching to that branch to rebuild their Dev Environment. When they switch back, their environment can as well.

Cross-Platform Virtual Environment

Not everyone works on macOS laptops!

With our setup, you will be able to launch VS Code with a Virtual Environment to allow your Windows, macOS, and Linux Coders to access a consistent Dev Environment built explicitly for SFCC Projects. There are no weird issues with cross-platform dependencies, managing different versions of Node, etc.

Pair Programming for Entire Team

Pair Programming and Group Chat Already Installed.

Getting VS Code's Live Share & Live Share Audio to play well on one machine can be a challenge on its own, let alone your entire dev team. With our Remote Container, we have everything set up for you. We've also built-in better security than what is enabled by default. So team members don't have to worry about anonymous guests joining a pair programming session.

Run Custom DevOps Scripts

Executing Commands on your Dev Environment from VS Code.

There is always someone on your Dev Team creating handy DevOps tools to automate specific tasks. Sometimes you want to remove all the node_modules folders and start life over. We get it, and that's why we've baked in support for collecting your DevOps scripts and making them accessible via VS Code right from the Task Bar.

Easy to Customize for Your Team

Not every Dev Team works the same way, and that's OK.

We've already sorted out the basics to ensure everything you need to do SFCC Dev Work is supported, but we realize every team is different. We've documented everything you need to know to customize which VS Code Extensions are best for your team and how to configure Linters and Code Formatters for your teams' needs.

Frequently Asked Questions

What's the Difference?

That's a Great Question, and an important one to consider for your Team.

The first significant change is that VS Code will spin up your Dev Environment in a Virtual Machine. This method means each Dev Environment will be using the same OS ( Linux Debian 11 ) with identical versions of Node, NPM, etc. VS Code launches from within these containers ( not your local OS's version of VS Code ). VS Code Extensions or custom settings you have on your local instance of VS Code will not be installed in the Container ( unless you configured them to be in the Dev Container Settings ).

What about my Custom Theme?

Each Developer has their style, and there's no need to change that.

VS Code put a lot of thought into this regarding Virtual Dev Environments. When you spin up a Remote Development Container, VS Code will automatically pull in your Visual Settings. So your custom theme, fonts, icons, etc., should be just the way you had them in your native VS Code instance. The only exception is if your Remote Developer Container Settings set an override for this. That might be handy for teams that want a consistent VS Code theme with custom colors and fonts. If you wanted to do that with these containers, you 100% could.

Will my SSH Keys Still Work?

Remote Containers will be hard to use on a team if they don't.

Yes, VS Code already thought of this and has added support for using your development machines SSH Keys within your Remote Development Container. You will be able to use your IDE's terminal window to connect to GitHub or BitBucket without any issues.

Will Signed Commit Messages Work?

Some Dev Teams will need to make sure Git Commits can be signed.

Yes, we have added support for this into the Docker container. This setting is not enabled by default for VS Code Remote Containers, as you would need to add Operating System support for the Virtual Machine. So we took care of that in this project.

Can we Configure the Container?

Not every Dev Team will want the same thing.

Yes, anything that you can typically configure in VS Code can also be configured for your containers. Some teams make .code-workspace files for this very reason. However, that method does not solve the Operating System issues addressed using Remote Developer Containers.

Disclaimer

The trademarks and product names of Salesforce®, including the mark Salesforce®, are the property of Salesforce.com. SFCC DevOps is not affiliated with Salesforce.com, nor does Salesforce.com sponsor or endorse the SFCC DevOps products or website. The use of the Salesforce® trademark on this project does not indicate an endorsement, recommendation, or business relationship between Salesforce.com and SFCC DevOps.

sfcc-vscode-remote's People

Contributors

manifestinteractive avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.