kbfmf-libraries-beta-2 v1.0.26-beta

fe-designsystem

Development guide

1. Clone repository

2. npm install

3. settings enable eslint rules with vs code

.vscode workspace settings JSON (command P search for workspace settings)

{
  "files.associations": {
    "*.vue": "postcss"
  },
  "prettier.enable": false,
  "editor.formatOnSave": false,
  "editor.codeActionsOnSave": {
    "source.fixAll.eslint": true,
    "source.organizeImports": false,
    "eslint.validate": [
      "javascript",
      "javascriptreact",
      "typescript",
      "typescriptreact",
      "vue",
      "html",
      "markdown",
      "json",
      "jsonc",
      "yaml"
    ]
  }
}

4. npm run dev

your playground for development is sandbox folder

Build & Publish for testing porpose on npm

Important !!... After you test publish to npm, revert back package name and version befor create Pull Request same as before like in the repo to avoid conflict

1. Create NPM Account

If you don't have an npm account, you need to create one. Go to the npm website and sign up for a new account.

2. Login

Open your terminal or command prompt and run the following command to log in to your npm account:

npm login

You will be prompted to enter your npm username, password, and email address. Provide the required information to complete the login process.

3. Change to unique name

If you haven't created an npm package yet, you should choose a unique name for your package. Ensure that the name you choose is not already taken by another package. Edit your package.json file and update the "name" field to your desired unique name.

4. Build

Before publishing your package, it's a good practice to build your code to ensure that it's ready for distribution. If you have a build script defined in your package.json file, you can run it using the following command:

npm run build

This command will execute the build script and generate the necessary output files.

5. Publish

Finally, it's time to publish your package to the npm registry. Run the following command in your terminal:

npm publish

This command will package and publish your code to the npm registry. Make sure you are in the root directory of your package when running this command.

Congratulations! Your package is now published to the npm registry and can be installed by others using npm install.