jekingohel / efa-companies

🔥 efa-companies

EFA in the project name means used architecture pattern. This is a simple app which is a simple version of portfolio tracker.

📖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 (>=14.15.0)
• npm (>= 6.14.0)

Bootstrap

  git clone [email protected]:playerony/efa-companies.git
  cd efa-companies
  npm i

📜Scripts:

Development

• storybook - Run storybook.
• start - Run application in development mode.
• reinstall-deps - Run will remove all dependencies and reinstall them.

Build

• build - Build for production a ready application.
• build-storybook - Build a ready storybook.

Test

• test - Run tests.
• test:e2e - Run e2e tests.
• test:ci - Run tests in CI mode.
• test:watch - Run tests in watch mode.

Analyze

• lint - Run eslint. Output any errors 🚨.
• lint:fix - Run eslint. Fix any lint errors 🚨.
• typecheck - Run tsc. Output any errors 🚨.
• format - Run prettier to format all the files.

📚 Documentation

Commit Message Guideline

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