Skip to content
Imperadeiro98 edited this page Jan 22, 2015 · 2 revisions

#####README.md includes some basic instructions on getting started.

#Setting Up Your Environment

The GitHub Repository has everything you need to work on Aether. You'll need Node, NPM and Git installed.

####Clone the repository:

  • git clone https://github.com/codecombat/aether.git

####Go to the directory and npm install:

  • cd aether
  • npm install

####Running The Environment:

From the aether directory, run:

  • grunt # or grunt watch, to recompile on any changes

#####Then you can navigate to file://localhost/some/path/to/aether/build/index.html and see it in action.

###Things to keep in mind Edit the CoffeeScript source in /src and /test, not the transpiled JavaScript in aether/lib. Remember to create tests in the /test folder.

######To be added:

  • A rough layout of the code
  • How to run builds and tests
  • Guidelines for contribution
  • Beautify the page

Clone this wiki locally