--repo--

A starter project for my projects

---

Usage

git clone https://github.com/thedaviddias/basic-project-template.git YOURFOLDERNAME
cd YOURFOLDERNAME

# Run yarn install and answer the questions prompted. That's all!
yarn install

Features

• Zero-setup. After running npm install or yarn install things will setup for you 😉
• Tests, coverage and interactive watch mode using Jest
• Prettier for code formatting and consistency
• Automatic releases and changelog, using Semantic release (using Github actions)

Requirements

• You will need to add to your Github Secrets, a NPM_TOKEN for the Semantic Release Authentication Environment Variables.
• Add your project to Codecov
• If your repo is private only, you will need to add to your Github Secrets, a CODECOV_TOKEN

NPM scripts

• npm run lint: Lint and fix your code
• npm run test:watch: Run test suite in interactive watch mode
• npm run test:prod: Run linting and generate coverage
• npm run commit: Commit using conventional commit style (husky will tell you to use it if you haven't 😉)

Useful commands

Ensure your package.json is organized correctly

npx sort-package-json

Useful bots

These following bots can be installed to help automating some tasks:

• @all-contributors bot: To automate acknowledging contributors to the project
• Semantic Pull Requests: To ensure that the PR is following semantic commit convention. After installing this bot, you can go to your Settings > Branches, "Branch protection rules" section and
• Probot: Stale - Closes abandoned Issues and Pull Requests after a period of inactivity

Github actions

• Semantic Release Action - Github action for Semantic Release
• Codecov Github Action - To easily upload coverage reports to Codecov

Contributors