🚀 Getting Started

You can use the library into your projects, you need only install de package, also you need request a NPM Token, send an email requesting access to a member team.

Then if you having the token, you add ~/.npmrc file in your root project and include your token.

//registry.npmjs.org/:_authToken=${NPM_TOKEN}

Finally, you are ready!

yarn add --save @alicorpdigital/dali-components-react

or

npm install --save @alicorpdigital/dali-components-react

🚧 How to use

1. Install CSS files

The CSS styles is another package, you need install for see your correct styles. Try with these:

yarn add --save @alicorpdigital/dali-css-library

or

npm install --save @alicorpdigital/dali-css-library

After installing the library, you can add it to your project using the following line, but don't forget that we work with multi-themes so you'll have to choose a theme for your use.

@import "@alicorpdigital/dali-css-library/build/css/themes/theme-alicorp/style.css";

Also you can use the minify version:

@import "@alicorpdigital/dali-css-library/build/css/themes/theme-alicorp/style.min.css";

2. Import components

import React from "react";
import { Button, Heading } from "@alicorpdigital/dali-components-react";

📖 Documentation

The full documentation for React Components can be found on our website.

📋 Requirements for Development

You can use the below sections to get the application & tests up and running on your system. The required libraries for starting the application and running the tests have already been added to package.json root file. Please follow below steps to run commands required to install required libraries, start the application and run the tests.

0. Basic setup

• Package manager: Yarn
• Editing tool: Visual Studio Code Also you can install it using Chocolatey :D

  choco install vscode

• Very cool Visual Studio code extensions:
  • Find and fix problems with ESLint
  • Code formatting with Prettier
  • Supercharge Git with GitLens Note: You can install all those extensions accepting the recommendations after download and open the source code.

1. Software dependencies

• node 16.15.1
• npm 8.11.0 Node LTS v16.15.1 Also you can install them using Chocolatey or you can find another devices in NPM Page

  choco install nodejs-lts

2. Installation process

yarn

3. Environment variables to work it

We're working with a .env file with this information

NPM_TOKEN=need a NPM token

🔩 Build, Start and Test

How to build?

yarn build

How to start? Open a new terminal and run below command.

yarn dev

⚡ Contribute

• Our code is based on the Google TypeScript Style Guide recommendations and rules.
• We're following conventional commit rules based on this reference.
• Please send your contributions using Pull Requests following the GitFlow Flow rules and this Pull Request template.