Brainflash App

---

Client for Brainflash application, which is a flashcard portal.

📖 Table of Contents

• ✨ Getting started
  • Prerequisites
  • Bootstrap
• 📜 Scripts
  • Build
  • Test
  • Analyze
  • Development
• 📚 Documentation
  • Commit Message Guideline

✨ Getting started

Prerequisites

You need to have installed the following software:

• nodejs (>=12.13.1)
• npm (>= 6.13.0)

Bootstrap

  git clone [email protected]:Miczeq22/brainflash-app.git
  cd brainflash-app
  npm i
  cp .env.dist .env

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

📜 Scripts

Build

• build: Builds production ready application.

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

• start: Start app 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