https://github.com/hirwa13/node-typescript-starter-project

Node x TypeScript Starter Project
https://github.com/hirwa13/node-typescript-starter-project

nodejs pnpm typescript

Last synced: 17 days ago
JSON representation

Node x TypeScript Starter Project

• Host: GitHub
• URL: https://github.com/hirwa13/node-typescript-starter-project
• Owner: HIRWA13
• Created: 2024-06-11T11:17:09.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2024-06-21T08:46:04.000Z (6 months ago)
• Last Synced: 2024-06-22T02:05:38.265Z (6 months ago)
• Topics: nodejs, pnpm, typescript
• Language: TypeScript
• Homepage:
• Size: 11.7 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Node js and TypeScript Starter Project

This is a starter project for building Node.js applications using Typescript. it is set up with pnpm as the package manager.

## Project Setup

first install `pnpm` in your pc or mac [install here](https://pnpm.io/)

1. Clone the repository: 

```bash

   git clone https://github.com/HIRWA13/Node-Typescript-Starter-Project.git

```

2. Install the dependencies:

```bash

   pnpm install

```

## Available Scripts

This project includes the following scripts:

- `pnpm run build`: Compiles the TypeScript code to JavaScript and outputs it to the `dist` directory.

- `pnpm run start`: Runs the compiled JavaScript code from the `dist` directory.

- `pnpm run dev`: Runs the development server with hot reloading.

## Project Structure

The project has the following structure:

```

node-typescript-starter/

├── dist/            # Compiled JavaScript files

├── src/             # TypeScript source code

│   └── ...

├── .gitignore       # Git ignore file

├── package.json     # Project configuration and dependencies

├── pnpm-lock.yaml   # pnpm lock file

├── README.md        # Project Documentation

└── tsconfig.json    # TypeScript configuration

```

## Author

- [Junior Hirwa](https://github.com/HIRWA13)