md-components-library
v0.3.0
Published
> App based on typescript, react and styled-components (https://styled-components.com/docs/basics)
Downloads
16
Readme
React App Components Library (with styled-components)
App based on typescript, react and styled-components (https://styled-components.com/docs/basics)
INSTALLATION and START
git clone https://github.com/DrBoria/md-components-library.git
cd ./md-components-library
yarn
yarn start
If you got some errors with running project try to install latest version of node or run "yarn install --ignore-engines"
FOLDERS DESCRIPTION
public/ public files for build
src/ code of all application
/components moleculas in atomic design. Reusable components (like buttons, inputs etc.). Should have only ui logic, not business logic (dumb components).
/sections organisms in atomic design. Could contain business logic, but main purpose is combining components
/styles styles, themes, theme providers and so on
/utils functions helpers (fetch, get headers and so on)
index.tsx app entry point
index.css basic styles of application (html, body)
HOW TO WRITE CODE
Please use following style/princeples:
1) Use only dumb components (without business logic) in components folder
2) Components should know how do they look like, not sections that contains it
It means - instead of redefining styles on every page - just make new type of button/input inside button/input component and just pass this type on your page
3) Make sections and pages small and readable as it possible (no need to make more than 40 lines of jsx inside page)
** styles **
5) All app variables should be declared in /src/styles/baseTheme.ts
6) Better use varables from baseTheme.ts through the projects
7) Try to avoid template literal interpolation, cause it will brake styles autofix (no ${props => props.great && 'color: red'})