Fluid Designs

Contents

• About
• Pre-requisites
• Getting Started
• Architecture
• Lighthouse
• Finally

About

❗ Work in progress ❗

Pre-requisites

You will need to install NodeJS & Git to run locally

Getting Started

1. Install npm packages

npm i

2. Run locally!

npm run dev

This will run the development server and let you view on localhost:3000 by default. Check out the package.json for full list of scripts

Architecture

SEMVER versioning, MAJOR.MINOR.PATCH i.e.; MAJOR bump covers breaking changes. MINOR bump is for new features/ backwards compatible changes. PATCH bump for bug fixes.

ITCSS (Inverted Triangle CSS), a way of organising CSS into levels of specifity (low to high).

BEM naming convention; Block, Element, Modifier.

Commit messages should use the format type: description. Refer here for type options.

Lighthouse

Lighthouse is an important tool to review changes. Pre-commit, this should be run and documented here:

Details

Finally

Thanks for taking a look! Feel free to connect with me on LinkedIn or just drop me a message 🌊