IDE

Start by creating and cloning a fork of this repository if you haven't already, and then refer to the guides below for IDE-specific instructions.

Make sure that you've completed the steps on the following wiki pages:

• Node & npm Setup
• Git Setup

If the IDE you use isn't on this page, feel free to contribute instructions.

Visual Studio Code

1. Download and install Visual Studio Code from here.
2. Open up VSCode.
3. Go to File > Open Folder and navigate to the folder where you cloned the repository.
4. Since VSCode ships with built-in JavaScript & TypeScript support, you can start working on the repository now.
5. You can run the app using the built-in terminal, or an external terminal window by executing npm start

Optional

6. Install the TSLint extension to make it easy for you to follow the linting rules.

Webstorm

1. Download and install Webstorm from here.
2. Open up Webstorm.
3. Open the folder where you cloned the repository.
4. Wait for Webstorm to finish indexing all the files.
5. Click the Add Configuration... button on the top right.
6. Press the + button, and select npm.
7. In the command dropdown, select start.
8. Click Apply and OK.
9. Press the green triangle on the top right to run the application.

Optional

10. Create additional configurations to run other scripts from package.json, e.g. npm run lint, using the steps above.

Atom

1. Download and install Atom from here.
2. Open up Atom.
3. Click Open a Project and select the folder where you cloned the repository.
4. Go to File > Settings and click Install.
5. Search for the atom-typescript package and install it.
6. You can now start working on the project, run it using npm start from a terminal.

Optional

7. Install additional packages to help with linting, embedding a terminal, etc. Search for packages within Atom or here.