Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
matiaslopezd authored Mar 8, 2021
1 parent 63c360b commit 2cb8348
Showing 1 changed file with 4 additions and 52 deletions.
56 changes: 4 additions & 52 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,62 +2,14 @@

Boilerplate project for [Vue.js](https://vuejs.org/) and [Tailwind CSS](https://tailwindcss.com/) integration.

This is a fork of original [repository](https://github.com/ramigs/vue-tailwind-boilerplate), thanks [ramigs](https://github.com/ramigs). Dependencies were updated in this repository.
**This is a fork of original [repository](https://github.com/ramigs/vue-tailwind-boilerplate), thanks [ramigs](https://github.com/ramigs)**. Dependencies were updated in this repository.

## Commands used to generate this boilerplate

Scaffolded project structure and development environment with command:
The fastest way to start with boilerplate is executing this command:

```
vue create vue-tailwind-boilerplate
npx @videsk/vue-tailwind-boilerplate
```

Installed Tailwind CSS:

```
npm install tailwindcss
```

Imported Tailwind on `App.vue`:

```css
@tailwind base;
@tailwind components;
@tailwind utilities;
```

Created file `postcss.config.js` and added:

```js
module.exports = {
plugins: {
tailwindcss: {},
autoprefixer: {},
}
}
```

Created file `tailwind.config.js` and added:

```js
// tailwind.config.js
module.exports = {
purge: ['./index.html', './src/**/*.{vue,js,ts,jsx,tsx}'],
darkMode: false,
theme: {
extend: {},
},
variants: {
extend: {},
},
plugins: [],
}
```

## Compiles and hot-reloads for development
```
npm install -g @vue/cli-service-global
```
```
npm run serve
```
The npx package source code can you [find here](https://github.com/videsk/vue-tailwind-boilerplate-installer).

0 comments on commit 2cb8348

Please sign in to comment.