Adapt it library

Project Structure

✔ This is a component mix library to help you make websites projects faster.

Technologies

• Vite - An open-source web development framework created by Vercel usage to workflow the pages.
• Typescript - A strongly typed programming language.
• SCSS - A pre-processor scripting language that will be compiled or interpreted into CSS.
• ESlint - An open source project that helps you find and fix problems with your JavaScript code.
• Prettier - An opinionated code formatter.
• Stylelint - A mighty, modern linter that helps you avoid errors and enforce conventions in your styles.
• husky - Trigger actions before some git's execution.

Git Hub Template

• Workflows:

  • Lint - A action to run all the lint in the project (Stylelint and eslint)

• Issues:

  • Bug report template - A template to open a bug report.
  • Improvement request template - A template to open an improvement request.
  • Technical debit request template - A template to open a technical debit request.

• Scripts:

  • npm run lint or yarn lint- Script to verify lint in the project.
  • npm run lint:fix or yarn lint:fix - Script to fix all the lints in the project.
  • npm run build or yarn build - Script to bundle the library.
  • npm run prepare or yarn prepare - Script to configure husky.

Installation

• Clone the repository.
• Run npm install OR yarn install to download the dependencies.

Running

• First, run the development server:

npm run dev
# or
yarn dev

• Open http://localhost:3000 with your browser to see the result.

Test

npm run test
# or
yarn test

Publish

npm run build
# or
yarn build

• Update the version in package and run:

npm publish

Dev

• Jean Lima