https://github.com/codelytv/javascript-basic-skeleton
https://github.com/codelytv/javascript-basic-skeleton
Last synced: 6 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/codelytv/javascript-basic-skeleton
- Owner: CodelyTV
- License: mit
- Created: 2021-03-23T14:03:41.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2023-02-06T13:55:29.000Z (almost 3 years ago)
- Last Synced: 2025-05-26T09:43:32.193Z (8 months ago)
- Language: JavaScript
- Size: 259 KB
- Stars: 213
- Watchers: 10
- Forks: 74
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# JavaScript Bootstrap (base / project starter)
This is a repository intended to serve as a starting point if you want to bootstrap a project in modern vanilla JavaScript.
## Features
- [Webpack](https://webpack.js.org/) (v5)
- [Babel](https://babeljs.io/) with [preset-env](https://babeljs.io/docs/en/babel-preset-env)
- [Prettier](https://prettier.io/)
- [ESLint](https://eslint.org/) with:
- [Codely's config](https://github.com/lydell/eslint-plugin-simple-import-sort/) (includes ESLint's recommended rules, Prettier, Import plugin and more)
- [HTML plugin](https://github.com/BenoitZugmeyer/eslint-plugin-html)
- [Jest](https://jestjs.io) with [DOM Testing Library](https://testing-library.com/docs/dom-testing-library/intro)
- [Cypress](https://www.cypress.io/) with [Testing Library](https://testing-library.com/docs/cypress-testing-library/)
- [GitHub Action workflows](https://github.com/features/actions) set up to run tests and linting on push
## Running the app
```
# install dependencies
npm install
# run in dev mode on port 8080
npm run dev
# generate production build
npm run build
# run generated content in dist folder on port 8080
npm run start
```
## Testing
### Jest with Testing Library
```
npm run test
```
### Cypress
```
# run in dev mode on port 8080
npm run dev
# open Cypress to run tests on dev mode
npm run cy:open
# open Cypress on CLI
npm run cy:run
```
## Linting
```
# run linter
npm run lint
# fix lint issues
npm run lint:fix
```