https://github.com/bobbyquennell/simple-ts-app

a simple template to bootstrap your TS project (backend)
https://github.com/bobbyquennell/simple-ts-app

eslint jest nodejs typescript

Last synced: 4 days ago
JSON representation

a simple template to bootstrap your TS project (backend)

• Host: GitHub
• URL: https://github.com/bobbyquennell/simple-ts-app
• Owner: bobbyquennell
• Created: 2022-02-08T13:08:07.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-04-17T06:34:06.000Z (10 months ago)
• Last Synced: 2024-11-24T19:15:22.267Z (2 months ago)
• Topics: eslint, jest, nodejs, typescript
• Language: JavaScript
• Homepage:
• Size: 508 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Simple Typescript App

a simple app to kickstart your ts project (backend)

## Prerequisites

- [TypeScript](https://www.typescriptlang.org/download) 5.4.5+

- [Node.js](https://nodejs.org/en/) LTS version (or later)

  

## How to Run

### 1. Git Clone

---

```bash

git clone [email protected]:bobbyquennell/simple-ts-app.git && cd simple-ts-app

```

### 2. bootstrap the project

---

 run below cmd in the project's ***root*** folder

 ```bash

 npm install && npm run build

 ```

### 3. Run the App

```bash

npm run start-dev 

```

## Run tests

---

 ```bash

 npm run test

 ```

## Technologies Included

- TypeScript + NodeJS

- ESLint config for Typescript and Javascript

- Prettier with auto formatting on save

- Husky + lint-Staged

- testing with `Jest` and enforce testing styles with `eslint-plugin-jest`