https://github.com/colemars/test-deepkit

https://github.com/colemars/test-deepkit

Last synced: 8 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/colemars/test-deepkit
• Owner: colemars
• License: mit
• Created: 2023-10-20T06:02:04.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-07-15T11:31:34.000Z (6 months ago)
• Last Synced: 2024-12-24T16:53:53.549Z (12 days ago)
• Language: TypeScript
• Size: 554 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Quick TS Setup

> Quick TypeScript setup for projects

This repository provides a default configuration to quickly start TypeScript projects. It comes with minimal Prettier, ESLint and Jest configurations, along with features like automatic server restart, environment variables support, debug mode, and Git hooks. Additionally, it provides VSCode extensions and settings recommendations.

## Installation

1. Clone this repository: `git clone https://github.com/casantosmu/quick-ts-setup.git`

2. Navigate to the project directory: `cd quick-ts-setup`

3. Install the dependencies: `npm install`

## Configuration

Before starting your project, please make the following changes:

- Update the information in `package.json`:

  - `"name"`: Change the name of the project.

  - `"description"`: Modify the project description.

  - `"author"`: Update the author field.

  - `"license"`: Change the license if needed.

- Clean Git history:

  - Remove the existing Git repository by deleting the `.git` folder.

  - Initialize a new Git repository: `git init`.

  - Make an initial commit: `git add .` and `git commit -m "Initial commit"`.

- Update the README.md:

  - Modify the content of the README.md file to provide information about your project.

- (Optional) Remove or modify any additional files, such as workflows, that are not needed for your project.

## Usage

- `npm start`: Start the application.

- `npm run build`: Compile TypeScript code into the `dist` folder.

- `npm run dev`: Start the application in development mode with automatic restart, debug mode, and environment variables loaded from `.env`.

- `npm test`: Run the test suite with loaded environment variables from `.env`

- `npm run test:watch`: Run the test suite in watch mode.

- `npm run test:coverage`: Run the test suite with code coverage analysis.

- `npm run lint`: Run ESLint for static code analysis.

- `npm run prettify`: Automatically format the code with Prettier.

- `npm run typecheck`: Run TypeScript type checking.

- `npm run prepare`: Install Husky Git hooks.

## License

This project is licensed under the [MIT License](LICENSE).