K-FOSS/TS-ESWeb Repository Template

STATUS: WIP

This will be the production ready NPM module variant of the @K-FOSS/TS-ESWeb-POC

Usage

On the GitHub Website click "Use this template"

Once you have cloned the template locally search and replace and usage of TS-Core with the name of your new project

Development

Setting up the development container

Follow these steps to open this project in a container:

1. If this is your first time using a development container, please follow the getting started steps.

2. To use this repository, you can either open the repository in an isolated Docker volume:

   • Press F1 and select the Remote-Containers: Open Repository in Container... command.
   • Enter K-FOSS/TS-ESWeb
   • The VS Code window (instance) will reload, clone the source code, and start building the dev container. A progress notification provides status updates.

   Or open a locally cloned copy of the code:

   • Clone this repository to your local filesystem.

     • git clone https://github.com/K-FOSS/TS-ESWeb.git

   • Open the project folder in Visual Studio Code.

     • code ./TS-Core-Template

   • Reopen in Container

     • When you open the project folder in Visual Studio Code you should be prompted with a notification asking if you would like to reopen in container.

     Or manually reopen

     • Press F1 and select the "Remote-Containers: Open Folder in Container..." command.

Running

Open a VSCode Terminal

npm run dev

Or launch with the VSCode Debugging tab