ercarval / mavensmate

MavensMate is a collection of open source projects that aims to make building Salesforce applications accessible to developers who prefer to build applications using their local machine in text editors like Sublime Text, Atom, and Visual Studio Code.

MavensMate - Open Source IDEs for Salesforce

Update: August 7, 2017

MavensMate is no longer being actively developed or supported. We recommend using Salesforce's official Visual Studio Code plugin for building Salesforce applications.

Overview

MavensMate is a collection of open source projects that aims to make building Salesforce applications accessible to developers who prefer to build applications using their local machine in text editors like Sublime Text, Atom, and Visual Studio Code. MavensMate is created and maintained by Joe Ferraro with support from Mavens and these amazing contributors.

Because there are several open source MavensMate projects, it can be somewhat confusing to navigate the ecosystem. In essence, there are three main components to the architecture: the server, the desktop application, and the editor plugins.

Quickstart for Salesforce Developers

1. Download and install MavensMate Desktop
2. Choose your editor (Sublime Text 3, Atom, Visual Studio Code) and install the appropriate MavensMate plugin
3. Happy coding!

Quickstart for MavensMate Contributors

• Coming soon

Components

• MavensMate Server
• MavensMate Desktop
• Editor Plugins
• Node Module
• Command Line Interface

MavensMate Server

MavensMate Server is a local Node.js Express server that facilitates communication/integration between editors like Sublime Text, Atom, and Visual Studio Code, the local file system, and the Salesforce servers. When a plugin requests a command to be run (e.g. "compile a file"), a local HTTP request is made to MavensMate Server, the server executes the requested command (which often requires communicating with a remote Salesforce.com environment) and returns the response to the plugin.

• Documentation: https://github.com/joeferraro/MavensMate/tree/master/docs/server
• GitHub Project: https://github.com/joeferraro/MavensMate

MavensMate Desktop

Platform	Status
OS X / Linux
Windows

MavensMate Desktop is an application that bundles the local MavensMate server into a desktop application that powers the MavensMate Sublime Text, Atom, and Visual Studio Code plugins.

• Documentation: coming soon
• GitHub Project: https://github.com/joeferraro/MavensMate-Desktop

Plugins

MavensMate for Sublime Text

• Documentation: coming soon
• GitHub Project: https://github.com/joeferraro/MavensMate-SublimeText

MavensMate for Atom (beta)

• Documentation: coming soon
• GitHub Project: https://github.com/joeferraro/MavensMate-Atom

MavensMate for Visual Studio Code (coming soon)

• Documentation: coming soon
• GitHub Project: https://github.com/joeferraro/MavensMate-VisualStudioCode

Contributors

• [Joseph Ferraro] (http://github.com/joeferraro)
• [Ralph Callaway] (http://github.com/ralphcallaway)
• [Kyle Thornton] (http://github.com/kylethornton)
• [David Helmer] (http://github.com/kidtsunami)
• [Justin Silver] (http://github.com/doublesharp)

#FAQ

• coming soon