Skip to content

Jozwiaczek/chat-app

Repository files navigation

Chat PoC App

Live app: jj-chat-app.netlify.app

UI/UX: figma.com/jj-chat-app


Netlify Status CI

🚩 Table of Contents

📖 About

Demo chat application

🎓 Getting started

Prerequisites

General installation

yarn

📦 Packages Docs

📏 Conventional Commits

Commitlint checks if your commit messages meet the conventional commit format. Also it requires package scope (https://www.npmjs.com/package/@commitlint/config-lerna-scopes).

Structure:

type(package-name): general info

Structure with more inforamtion:

type(package-name): general info

- add login panel
- add avatar

Example:

feat(api): add comment section

Common types according to commitlint-config-conventional (based on the Angular convention) can be: conventional-commit-types. Header (first line) must not be longer than 100 characters.

For just validating your commit message without commiting it use terminal:

echo 'foo: bar' | commitlint

📝 Available scripts

To run script, in terminal type yarn {script}.

Script Description Note
build
check Runs linter, prettier, tests and ts-check in all packages
heroku-postbuild It runs on heroku before api build
preinstall Checks is yarn was used package manager It runs automatically before every install
lint Checks linter rules
lint:fix Fix linter
stylelint Check styled-components
prettier Checks prettier rules
prettier:fix Fix prettier
prepare Install husky git hooks
removeNodeModules Remove all node_modules from project (all packages) Works only for unix systems
sortPackageJson Sort alphabetical all package.json in project
start Used to run api package on heroku
test Runs tests for all packages
type-check Checks TypeScript types for all packages

License

Copyright 2021 Jakub Jóźwiak. Licensed under the MIT license.