Learn IDE is a fully featured text editor for Learn. It provides a remote development environment to allow users to get started coding using real tools without the pain of setting one up locally. It is built on top of Github's open source Atom editor.
The Learn IDE client is a modified Atom build with two packages injected to provide functionality with a remote backend that provides a ready to go development environment for Learn users.
Those two packages include a couple important libraries:
The Learn IDE application currently uses Atom at v1.14.2, which runs Electron at v1.3.13. While developling, be sure that you are referring to the documentation that corresponds to these specific versions.
git clonegit clonegit clone
npm installin each repo
apm linkinside each repo - This will create a sym link to your .atom directory, making the plugin available for use.
gulp build - Builds the Atom application with our packages injected ready for distribution and swaps out icons and names to brand it the Learn IDE. On Mac, this will automatically attempt to sign the application using Flatiron School's development certificate (which must be installed on your machine). On Windows, the installer must be signed manually.
packageDependencies are up-to-date in
apm publish <major|minor|patch>- bumps the package version according to the specified semver segment, tags it, and publishes the tag to apm
package.json, e.g. the pre-release version for v2.5.0 would be
git commit -am "prep v2.5.0-beta0" && git tag v2.5.0-beta0
git push && git push --tags
apm publish --tag <tag>, e.g.
apm publish --tag v2.5.0-beta0
You can configure the Learn IDE by creating a
.env file either in Atom's home (e.g.
~/.atom/.env) or wherever the package is being run (e.g.
~/development-stuff/learn-ide/.env). The following keys can be used:
||The host used for websocket connections|
||The port used for websocket connections|
||The path used for websocket connections|
||The location of learn to connect to|
IDE_LEARN_CO key is useful for developers and testers at Flatiron School, as it can be used to point the client to a local or QA environment; however, it does not change the IDE server's knowledge of Learn's location. In other words, you must sign in to the IDE with a production user, as the IDE servers will authenticate you against the Learn production environment.
Learn IDE is MIT licensed
Good catch. Let us know what about this package looks wrong to you, and we'll investigate right away.