README.md

Welcome to brackets.io

This is the offcial repository for the brackets.io website

Development

While the js, and html can be modified right in the repository, the sass stylesheets for brackets.io exist in another repository - brackets-site-sass, and are included in as a submodule.

This is because the same style sheets are shared by brackets-registry as well.

Refer to the section below for assistance on how to develop the css for brackets.io

Developing CSS

• Requirements

  • Git command line tools — follow the setup instructions on GitHub or download here
  • NodeJS installed. Tested with node v6.3.1 & npm v5.5.1

• Steps to follow

  • Open gitbash (or any other command line shell of your choice, that supports git & node) & clone the repository

    git clone https://github.com/adobe/brackets.io.git
    cd brackets.io

  • Update the brackets-site-sass submodule

    git submodule update --init

  • Change directory to the brackets-site-sass submodule

    cd dev

  • Get the development dependencies for the submodule

    npm install

    The brackets-site-sass folder contains the scss folder, which contains the sass files that were used to develop the minified css(brackets.min.css). Any modification that needs to be made to the minified css must be made by compiling these scss files.

  • And then run the auto-compile grunt task

    grunt watch

  The above task will watch the scss folder for any changes. Post this, you can modify the files in the scss folder and brackets.min.css will be automatically generated in the css folder.

  Note: You must keep the grunt task running for the automatic compilation to work, so don't close the shell running the task.

  Note: Also, test the new styles with brackets-registry as well, and update the minified css there as well.

Running brackets.io locally

• Requirements

  • http-server

    npm install -g http-server

• Steps to follow

  • Open gitbash (or any other command line shell of your choice, that supports git & node)

  • Change directory to local brackets.io repository

  • Start the http-server

    http-server ./

    This will start a local http-server on the 8080 port. The site can then be viewed using http://localhost:8080 in browser.

    http-server can also be started with options for port, address etc. Check the npm page for more details

  Note: Chrome generally caches resources, and so sometimes, even on reloading, code changes are not reflected. In such a case, use the Empty Cache and Hard Reload option in Chrome.