https://github.com/ivanjermakov/ts-template

Typescript template project
https://github.com/ivanjermakov/ts-template

Last synced: 6 days ago
JSON representation

Typescript template project

• Host: GitHub
• URL: https://github.com/ivanjermakov/ts-template
• Owner: ivanjermakov
• License: mit
• Created: 2022-04-28T18:51:50.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2022-04-30T10:53:58.000Z (over 2 years ago)
• Last Synced: 2023-03-07T13:28:15.965Z (over 1 year ago)
• Language: TypeScript
• Size: 10.7 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ts-template

Typescript template project

## Features

- Typescript entry point `index.ts`

- Scripts for building and running

- Unit testing with [jasmine](https://github.com/jasmine/jasmine)

- Environment variable driven config with [dotenv](https://github.com/motdotla/dotenv)

- GitHub actions pipeline for `npm run test`

## Prerequisites

- [Node.js](https://nodejs.org/en/)

- [Git](https://git-scm.com/)

## Setup

1. Clone the project

   ```

   git clone https://github.com/ivanjermakov/ts-template 

   cd 

   ```

2. Install dependencies

   ```

   npm install

   ```

3. Start the app

   ```

   npm run start

   ```

## Initial customization

1. Update all `/<.*>/` templates across the project (e.g. `` or ``)

3. Update `LICENSE` (MIT by default)

4. Replace `README.md`

 

5. Write your code with `index.ts` as an entry point