\n\n## Getting Started\n\n- Clone repository\n\n```bash\ngit clone https://github.com/dannyfranca/typescript-boilerplate.git {{project_name}}\n```\n\n- Install dependencies\n\n```bash\ncd {{project_name}}\nyarn\n```\n\n## Warnings\n\n- Experimental environment. Could change many times between versions, at least until v1.0 arrives.\n- If you don't want to use yarn, change yarn run for npm run in package.json commands and .lintstagedrc\n\n## Libs\n\n- Compiler - TypeScript\n- Linting - TypeScript ESLint\n- Code Formatter - Prettier\n- Bundler - Parcel JS\n- E2E/Unit/CI Suite - Cypress\n- Coverage Reports - Istanbul\n- Continuous Integration - CircleCI / TravisCI\n- Code Coverage - Codecov\n- Git Hooks - Husky + lint-staged\n\n## Usage\n\nStart writing in src folder. modify any project files that fits you needs.\n\nIn package.json you have commands to dev, test, compile and build.\n\n### NPM Commands\n\n#### Test\n\nCommands to test you application\n\n- _dev_: Start developing with Parcel, Cypress and code coverage, all hot reloading\n- _test_: If you want to test and generate code coverage reports, use before publish\n- _cy:open_: Open cypress to test (server must be already running). Useful if you are already developing and just need to make some tests, without reload the whole process\n- _cy:run_: Run tests in terminal, without UI. Useful the same way cypress:open is\n- _coverage_: You don't need to run this command, it's for Circle CI perform Continuous Integration after git push\n\n#### Bundle\n\nCommands to help you bundling you front-end application\n\n- _start_: to develop only with Parcel, without tests and code coverage\n- _build_: Generate production bundles from public to dist folder\n- _doc_: Generate documentation from comments with Typedoc\n\n#### Module\n\nCommands to help you compile your TypeScript application to interoperable modules.\n\n- _compile_: Compile your TypeScript files in \"src\" to \"lib\" folder, with types, making your module interoperable with JavaScript\n- _compile:watch_: Same as compile, but keeps a process watching and recompiling the changes\n- _compile:types_: Only emits the type declaration files\n- _type-check_: Only check the types, good to run between commits to get errors when working with multiple files (If using built in git hooks with Husky, executed automatically before any commit)\n\n## Conclusion\n\nHave a Nice Coding! 🤓\n\n## License\n\n[MIT License](./LICENSE)\n\nCopyright (c) Danny França \n","readmeFilename":"README.md"}
![](\"https://img.shields.io/npm/dt/@dannyfranca/typescript-boilerplate.svg?style=flat-square&logo=npm\")
\n\n\n\n ![](\"https://img.shields.io/npm/v/@dannyfranca/typescript-boilerplate/latest.svg?style=flat-square&logo=npm\")
\n\n\n\n ![](\"https://img.shields.io/travis/dannyfranca/typescript-boilerplate?style=flat-square&logo=travis\")
\n\n\n\n ![](\"https://img.shields.io/circleci/project/github/dannyfranca/typescript-boilerplate?style=flat-square&logo=circleci\")
\n\n\n\n ![](\"https://img.shields.io/codecov/c/github/dannyfranca/typescript-boilerplate?style=flat-square&logo=codecov\")
\n\n\n\n ![](\"https://david-dm.org/dannyfranca/typescript-boilerplate/status.svg?style=flat-square\")
\n\n\n\n ![](\"https://img.shields.io/codacy/grade/addca1007fb044c3a994c7e0ec504092?style=flat-square&logo=codacy\")
\n\n\n