@placetopay/spartan-vue

Spartan VueJs

SpartanVue is a vue component library that contains the components used in the PlacetoPay web applications based in TailwindCSS.

Desing system

You can find the documentation and components of this design system by clicking here.

Installing

1. Requirements

   • NodeJs ^16 or NVM (for use multiple versions of nodejs)
   • NPM ^7
   • Github personal access token with "read:packages" permissions

2. Install in the consumer project

   npm install -D @placetopay/spartan-vue @tailwindcss/forms

3. Configure your tailwind.config.js add the presets key and content element for the package

   module.exports = {
      content: [
         //...
         "node_modules/@placetopay/spartan-vue/dist/*.js",
      ]
      presets: [require("@placetopay/spartan-vue/tailwindcss.js")],
   };

Developing

1. Requirements

   • NodeJs 16
   • NPM 7
   • Set ssh key in your github account

2. Clone the repository

   git clone [e-mail]:placetopay-org/spartan-vue.git

3. Install dependencies

   npm install

   cp .env.example .env

4. Run the project

   npm run dev:storybook

5. Open the project in your browser

   http://localhost:6006

6. Happy coding!