Installing TypeScript

This is a skeleton app for people who want to use TypeScript. A docker-compose file is included for those who want to run it in a container.

You don't have to use the docker-compose file if you're fine with installing NodeJS and NPM locally. Feel free to delete it if that's the case.

Prerequisites

Make sure you have NodeJS installed (preferably the LTS version). This will also install npm.

1. Open a terminal window (command prompt, git bash, powershell)
2. Check if NodeJS is installed by typing node --version into the terminal. It should print a line with something like v18.18.0.
3. Check if NPM is installed by typing npm --version into the terminal. It should print a line with something like 9.8.0.

Instructions

1. Clone or download this repository to your computer
2. Open a terminal in the project directory.
3. Install the dependencies by running npm install.
4. Compile the project by running npm run build. If you want to run the build script everytime you make changes automatically, you can use npm run watch.
5. Run the application. You cannot just open the index.html file (see the following section). If everything worked properly, you should see "Hello World" printed to the document.

Webserver

Applications built with es6 (and higher) modules must be run on a webserver. On Visual Studio Code, Live Server is recommended. Otherwise XAMPP or MAMP can be used.

An example index.html is provided. You cannot load the index.html from your filesystem. It will not work!

Recommended VS Code Extension

• To use the provided .editorconfig file, install the EditorConfig plugin.
• To use the provided .eslintrc.cjs file, install the ESLint plugin.

Using Docker

If you're like me and you dislike NodeJS and NPM piling up heaps of folders on your pc, run TypeScript in Docker!

1. Install Docker Desktop.
2. Open a terminal window (Powershell on Windows, regular command prompt will not work).
3. Clone this repository.
4. Move to this folder inside the terminal.
5. Run docker-compose up and open a new terminal OR run docker-compose up -d which allows you to work in the same terminal.
6. Follow the steps from Instructions from step 4, but prefix all the commands with docker-compose exec ts-app.
7. Close the docker container by pressing ctrl + c or docker-compose down, respectively for step 5