https://github.com/yazaldefilimone/javascript-starter

JavaScript starter with vitetest, prettier, eslint. All the tools you need to build your project.
https://github.com/yazaldefilimone/javascript-starter

Last synced: about 1 month ago
JSON representation

JavaScript starter with vitetest, prettier, eslint. All the tools you need to build your project.

• Host: GitHub
• URL: https://github.com/yazaldefilimone/javascript-starter
• Owner: yazaldefilimone
• Created: 2023-10-17T09:07:55.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2023-10-17T09:32:53.000Z (about 1 year ago)
• Last Synced: 2023-12-22T19:30:02.371Z (11 months ago)
• Language: JavaScript
• Size: 25.4 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        


 


  

  

  

  

  





JavaScript starter with vitest, prettier, eslint. 


All the tools you need to build your project.





## Features

- ⚡️ Vitest 0.34

- ⭐ Node 18

- 📏 ESLint — To find and fix problems in your code

- 💖 Prettier — Code Formatter for consistent style

- 🐶 Husky — For running scripts before committing

- 🚓 Commitlint — To make sure your commit messages follow the convention

- 🚫 lint-staged — Run ESLint and Prettier against staged Git files

- ⚙️ EditorConfig - Consistent coding styles across editors and IDEs

### Development

To start the project locally, run:

```bash

  npm dev

  our

  yarn dev

```

### Requirements

- Node.js >= 18.13.0

- npm our yarn

### Scripts

- `yarn/npm dev` — Starts the application in development mode.

- `yarn/npm build` — Creates an optimized production build of your application.

- `yarn/npm start` — Starts the application in production mode.

- `yarn/npm lint` — Runs ESLint for all files.

- `yarn/npm format` — Try format files use prettier.

- `yarn/npm lint:fix` — Try fix files use eslint.

- `yarn/npm lint:all` — Runs all lint scripts and format: `npm run format && npm run lint:fix && npm run lint` .

- `yarn/npm test` — Runs test files without watch mode.

- `yarn/npm test:watch` — Runs test files with watch mode.

- `yarn/npm test:ui` — Run in browser UI views tests.

- `yarn/npm test:coverage` — Runs test files with coverage report.



### License

[MIT](https://github.com/yazaldefilimonepinto/javascript-starter/blob/main/LICENSE) © [Yazalde Filimone](https://www.linkedin.com/in/yazalde-filimone/)