{"id":24431940,"url":"https://github.com/damianravindupeiris/typescript-bootstrapper","last_synced_at":"2026-04-29T02:42:49.654Z","repository":{"id":271993643,"uuid":"915208881","full_name":"DamianRavinduPeiris/typescript-bootstrapper","owner":"DamianRavinduPeiris","description":"This script automates the process of setting up a new TypeScript project with a Node.js environment. It handles the initialization of a Git repository, installs necessary dependencies, configures TypeScript, and sets up a development environment with nodemon and ts-node for live reloading.","archived":false,"fork":false,"pushed_at":"2025-01-11T09:05:43.000Z","size":12,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-01-20T15:41:22.234Z","etag":null,"topics":["automated","development-environment","script","typescript"],"latest_commit_sha":null,"homepage":"https://www.typescriptlang.org/","language":"PowerShell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/DamianRavinduPeiris.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2025-01-11T08:49:31.000Z","updated_at":"2025-01-11T09:06:49.000Z","dependencies_parsed_at":"2025-01-20T15:34:50.403Z","dependency_job_id":null,"html_url":"https://github.com/DamianRavinduPeiris/typescript-bootstrapper","commit_stats":null,"previous_names":["damianravindupeiris/typescript-bootstrapper"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DamianRavinduPeiris%2Ftypescript-bootstrapper","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DamianRavinduPeiris%2Ftypescript-bootstrapper/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DamianRavinduPeiris%2Ftypescript-bootstrapper/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DamianRavinduPeiris%2Ftypescript-bootstrapper/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DamianRavinduPeiris","download_url":"https://codeload.github.com/DamianRavinduPeiris/typescript-bootstrapper/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243475372,"owners_count":20296712,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["automated","development-environment","script","typescript"],"created_at":"2025-01-20T15:28:42.840Z","updated_at":"2026-04-29T02:42:49.608Z","avatar_url":"https://github.com/DamianRavinduPeiris.png","language":"PowerShell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# TypeScript Bootstrapper 🚀\n\n![image](https://github.com/user-attachments/assets/726ab224-bc3b-4843-ada9-ae9ed67a60dc)\n\n\nThis script automates the process of setting up a new TypeScript project with a Node.js environment. It handles the initialization of a Git repository, installs necessary dependencies, configures TypeScript, and sets up a development environment with `nodemon` and `ts-node` for live reloading.\n\n## Features:\n- Initializes a Git repository.\n- Installs and configures TypeScript.\n- Creates a `tsconfig.json` file with the proper setup.\n- Installs necessary development dependencies like `nodemon` and `ts-node`.\n- Sets up `npm` scripts for development and production.\n- Creates a basic `index.ts` file with a sample message.\n- Configures `nodemon` to watch TypeScript files.\n\n## Prerequisites:\nEnsure you have the following installed:\n- **Node.js** (version 16 or higher recommended)\n- **Git** (for initializing the repository)\n- **npm** (Node Package Manager)\n\n## How to Use:\n1. **Clone the Git repository** (if you don't already have it):\n   ```bash\n   git clone https://github.com/DamianRavinduPeiris/typescript-bootstrapper.git\n   cd typescript-bootstrapper\n   ```\n\n2. **Run the script using Windows Powershell.**:\n   Open up a new Powershell window and execute the below command in the above project location.\n   \n   ```bash\n   ./setup-typescript.ps1\n   ```\n\n   You will be prompted to enter the name of your project folder. The script will:\n   - Create the project folder.\n   - Initialize a Git repository inside the folder.\n   - Set up `npm` and install the required dependencies.\n   - Generate a `tsconfig.json` file for TypeScript.\n   - Install `nodemon` for live reloading and `ts-node` for running TypeScript files directly.\n   - Create an initial `index.ts` file and a `nodemon.json` configuration file.\n\n3. **Run the development environment**:\n   After the script finishes setting up the project, you can start the development server using `npm run dev`:\n   ```bash\n   npm run dev\n   ```\n\n   This will start `nodemon` and run your `index.ts` file using `ts-node`. Any changes made to the `.ts` files will automatically trigger a reload.\n\n   ⛔ **PS - Since the git initializing project is done by the script iteslf,you will get an error when interacting with `git`. To avoid it simply run the below command in your project folder.**\n\n\n    `git config --global --add safe.directory C:/Example/Your-project`\n\n5. **Run the production environment**:\n   To run the compiled JavaScript code in the `dist` folder, use:\n   ```bash\n   npm run start\n   ```\n\n6. **Modify your TypeScript code**:\n   You can now start coding in TypeScript! Your TypeScript files should be placed in the `src` folder. When you're ready to compile, the TypeScript compiler will output JavaScript files to the `dist` folder.\n\n## File Structure:\nOnce the script is executed, the following file structure will be created:\n\n```\nyour-project-folder/\n│\n├── dist/            # Compiled JavaScript files\n├── node_modules/    # Installed dependencies\n├── src/             # TypeScript source files\n│   └── index.ts     # Sample TypeScript file\n├── package.json     # Project configuration file\n├── tsconfig.json    # TypeScript configuration file\n├── nodemon.json     # Nodemon configuration for development\n└── .git/            # Git repository initialization\n```\n\n## Contributing:\nIf you would like to contribute to this project or improve the script, feel free to open a pull request.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdamianravindupeiris%2Ftypescript-bootstrapper","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdamianravindupeiris%2Ftypescript-bootstrapper","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdamianravindupeiris%2Ftypescript-bootstrapper/lists"}