LouaieRbiha/Quizar_Backend

4Fun Quiz server application

🕺 Test Plateform

Server for Test plateform.

📖 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 (>=v12.18.4)
• npm (>= 6.14.6)

Bootstrap

  git clone git@github.com/LouaieRbiha/Quiz_server.git
  cd Server
  npm i

Please remember that config/*.json must be implemented for proper work.

📜 Scripts

Test

• test: Run jest.

Analyze

• format: Run prettier to format all files. Gets invoked by the pre-commit hook.
• lint: Run eslint and prettier. Output any errors.

Development

• dev: 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