https://github.com/horusgoul/node-ts-starter

Straightforward Node.js & TypeScript Starter
https://github.com/horusgoul/node-ts-starter

nodejs starter template typescript

Last synced: 2 months ago
JSON representation

Straightforward Node.js & TypeScript Starter

• Host: GitHub
• URL: https://github.com/horusgoul/node-ts-starter
• Owner: HorusGoul
• License: mit
• Created: 2020-02-15T13:05:48.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2023-01-08T22:36:52.000Z (about 2 years ago)
• Last Synced: 2023-02-27T08:56:35.774Z (almost 2 years ago)
• Topics: nodejs, starter, template, typescript
• Language: TypeScript
• Homepage:
• Size: 548 KB
• Stars: 53
• Watchers: 2
• Forks: 9
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Node TypeScript Starter

## Getting started

1. Clone this repository and open it

```bash

$ git clone https://github.com/HorusGoul/node-ts-starter your-next-project

$ cd your-next-project

```

2. Install dependencies

```bash

$ yarn

```

3. Launch the dev mode

```bash

$ yarn dev

```

4. You can start coding! The entry point is located in `src/index.ts`.

## What's preconfigured?

The intent of this starter is to be really slim so it's not a nightmare to remove or change stuff, that's why there are just a few things preconfigured:

- Babel

- TypeScript

- ESLint

- Prettier

- A pre-commit hook that runs ESLint and type checks the code base

- A few npm scripts

## Scripts

- `yarn dev`. Runs the project in dev mode, which means that it won't check types and will restart with every change you make.

- `yarn build`. Compiles the project to the `./dist` folder.

- `yarn typecheck`. Checks the typings of the project. Gets executed before trying to create a new commit but you can also run it manually.

- `yarn start`. Runs the compiled program. Remember to execute `yarn build` before attempting to launch the program.

- `yarn lint`. Runs ESLint. You can append `--fix` in order to fix autofixable issues.

## What to do next

Adapt the configuration to your needs and start coding!