CEF3-based application shell for Brackets.
Switch branches/tags
Clone or download
Latest commit 46b5708 Jul 24, 2018
Permalink
Failed to load latest commit information.
appshell Merge pull request #636 from pelatx/linux-window-state Jul 24, 2018
gyp Reapply "Fix directory copy for gyp on Windows" Apr 2, 2016
installer AutoUpdate Mac Installer Script Administrator privileges changes (#656) Jul 24, 2018
scripts Auto Update Framework (#634) Apr 18, 2018
tasks Revert "Adding maint version to brackets win installer (#640)" (#644) May 2, 2018
.brackets.json Switched from JSHint to ESLint Aug 25, 2016
.eslintignore Switched from JSHint to ESLint Aug 25, 2016
.eslintrc.json
.gitattributes
.gitignore
CEF-Info.plist - add Info.plist file for CEF framework to enable v2 code signing for… Sep 11, 2014
Gruntfile.js Upgrading node to v6.14.0 Jun 1, 2018
LICENSE Remove trailing whitespaces from license comments Sep 14, 2016
README.md Update note in readme Aug 4, 2015
appshell.exe.manifest HiDPI support in windows. Feb 10, 2015
appshell.gyp Now Windows CRT dlls are packaged with Brackets executable (#622) Aug 30, 2017
appshell_config.gypi CEF 2171 Dec 11, 2014
appshell_paths.gypi Auto Update Framework (#634) Apr 18, 2018
common.gypi Saurabh95/windows mac encoding support (#605) Jun 23, 2017
compatibility.manifest Update compatibility.manifest for Windows 10 Aug 14, 2016
package.json

README.md

Overview

This is the CEF3-based application shell for Brackets.

Please read the main README in the brackets repo for general information about Brackets.

If you are interested in contributing to this shell, let us know on the brackets-dev Google Group, or on the #brackets channel on freenode.

If you run into any issues with this new shell, please file a bug in the brackets issue tracker.

Note: The brackets-shell is only maintained for use by the Brackets project. Although some people have definitely had success using it as an app shell for other projects, we don't provide any official support for that and we haven't done a ton of work to make the app shell easily reusable. Many people will likely find it easier to use a project like NW.js or electron, which is more generic by design.

Running

There are no downloads for the brackets-shell. You either need to build from source, or grab the latest Brackets installer and run the shell from that.

When the app is launched, it first looks for an index.html file in the following locations:

  • Mac - Brackets.app/Contents/dev/src/index.html, Brackets.app/Contents/www/index.html
  • Win - dev/src/index.html, www/index.html (these folders must be in the same folder as Brackets.exe)
  • Linux - dev/src/index.html, www/index.html (these folders must be in the same folder as the Brackets executable)

If the index.html can't be found, you'll be prompted to find the brackets index.html file. Make sure you select the brackets/src/index.html file, and not some other file.

The preferences are stored in {USER}/Library/Application Support/Brackets/cef_data on Mac, {USER}\AppData\Roaming\Brackets\cef_data on Windows, and ~/.Brackets/cef_data on Linux.

Building

Information on building the app shell can be found on the brackets-shell wiki.