https://github.com/volesh/typescriptprojectsetup

Default settings for any TypeScript project. Includes TypeScript, Eslint, Prettier, Husky, Jest, CI/CD.
https://github.com/volesh/typescriptprojectsetup

cicd config default-project-setings eslint eslint-config husky-hooks jest-typescript prettier prettier-eslint typescript

Last synced: 7 days ago
JSON representation

Default settings for any TypeScript project. Includes TypeScript, Eslint, Prettier, Husky, Jest, CI/CD.

• Host: GitHub
• URL: https://github.com/volesh/typescriptprojectsetup
• Owner: volesh
• Created: 2024-05-03T08:00:34.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2024-05-03T18:09:50.000Z (5 months ago)
• Last Synced: 2024-09-28T01:09:00.551Z (7 days ago)
• Topics: cicd, config, default-project-setings, eslint, eslint-config, husky-hooks, jest-typescript, prettier, prettier-eslint, typescript
• Language: Shell
• Homepage:
• Size: 76.2 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
### Project Setup

This project is configured with the following tools and technologies:

- **TypeScript**: For writing type-safe code.

- **ESLint**: For linting TypeScript code.

- **Prettier**: For code formatting.

- **Husky**: To set up pre-commit hooks.

- **Jest**: For testing code.

### Usage

To get started, follow next steps:

 - **Clone repository**

```bash

git clone https://github.com/volesh/defaultProjectSetup.git

```

 - **Open cloned repository**

```bash

cd TypescriptProjectSetup

```

 - **Setup remote repository**

```bash

git remote set-url origin 

```

 - **Setup `package.json` file as needed**

 - **Install dependencies and push code to your repository**

```bash

npm install

git push origin 

```

### Continuous Integration/Continuous Deployment (CI/CD)

To enable CI/CD, rename `.github/workflows-stopped/CICD.yml` to `.github/workflows/CICD.yml` and  describe the deployment steps there.

### Husky Hooks

This project uses Husky to set up pre-commit hooks. It will automatically lint your code before committing.

### Contributing

Contributions are welcome! Please feel free to open issues or pull requests for any improvements or features you'd like to see.