Skip to content

Exlabs/value-driven-templates

Repository files navigation

🛠 Value Driven Templates

Test Lint Production Build

Collection of tools and frameworks in template form to help your team solve problems, make decisions, and successfully finish projects.

📖 Table of Contents

✨ Getting started

Prerequisites

You need to have installed the following software:

Bootstrap

  git clone git@github.com:Exlabs/value-driven-templates.git
  cd value-driven-templates
  cp .env.dist .env
  yarn

Please remember that .env must be implemented for proper work.

📜 Scripts

Build

  • build: Builds production ready application.

  • start: Start production ready environment.

Test

  • test: Run jest in standard mode.
  • test:watch: Run jest in watch mode.
  • test:ci: Run jest for CI purposes with coverage and database as docker container.

Analyze

  • typecheck: Run typescript in dry-mode (no output). Type errors will be printed to console.
  • format: Run prettier to format all files. Gets invoked by the pre-commit hook.
  • lint: Run eslint and prettier. Output any errors.

Development

  • dev: Run application in development mode.
  • version: Generates CHANGELOG file based on commit messages.

📚 Documentation

Commit Message Guideline

  • For easier commit type recognition commit messages are prefixed with an emoji
  • See available commit-emojis