https://github.com/tfd-ed/tfd-nuxt-tailwind-boilerplate
NuxtJs + TailwindCss + ESLint boilerplate
https://github.com/tfd-ed/tfd-nuxt-tailwind-boilerplate
babel eslint nuxtjs prettier tailwindcss vuejs vuex
Last synced: about 1 year ago
JSON representation
NuxtJs + TailwindCss + ESLint boilerplate
- Host: GitHub
- URL: https://github.com/tfd-ed/tfd-nuxt-tailwind-boilerplate
- Owner: tfd-ed
- License: gpl-3.0
- Created: 2021-08-13T17:19:07.000Z (almost 5 years ago)
- Default Branch: develop
- Last Pushed: 2025-01-15T10:46:31.000Z (over 1 year ago)
- Last Synced: 2025-04-30T03:49:24.535Z (about 1 year ago)
- Topics: babel, eslint, nuxtjs, prettier, tailwindcss, vuejs, vuex
- Language: Vue
- Homepage:
- Size: 729 KB
- Stars: 24
- Watchers: 1
- Forks: 36
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
A NuxtJs boilerplate by TFD for building scalable API.
Nuxt JS + Tailwind CSS + ESLint Boilerplate
## Features
This is a Nuxt JS + Tailwind CSS boilerplate code with preconfigured libraries and packages with the following features:
- Preconfigured [VueTailwind](https://www.vue-tailwind.com/) with highly customizable tailwind module
- Integrated [nuxt/axios](https://axios.nuxtjs.org/) for promise based HTTP client
- Integrated [nuxt/auth](https://auth.nuxtjs.org/) for authentication
- Integrated [nuxt-img](https://image.nuxtjs.org/components/nuxt-img/) to replace vanilla ``![]()
`` HTML tag for better image optimization
- Integrated [@nuxtjs/moment](https://www.npmjs.com/package/@nuxtjs/moment) for time formatting
- Smooth configurable page, layout transition at ``@/assets/css/main``
- Built-in awesome content loader using [vue-content-loader](https://www.npmjs.com/package/vue-content-loader)
- Integrated [@babel/eslint-parser, prettier](https://www.npmjs.com/package/@babel/eslint-parser) for codes' rules & styles checking and formatting
- Integrated [vuex-map-fields](https://www.npmjs.com/package/vuex-map-fields) for form data binding
## Setup Guide
**Be aware that** you might have to add **BASE_URL** to your environment variable in case you build for production.
### API Installation
This boilerplate fetch data from [tfd-nest-boilerplate](https://github.com/tfd-ed/tfd-nest-boilerplate). Make sure you install the server and run it. Here is the easy step to install the server ( Make sure you have [docker](https://www.docker.com/get-started) installed) :
``` bash
$ git clone https://github.com/tfd-ed/tfd-nest-boilerplate.git
cd tfd-nest-boilerplate
cp .env.example .env # or copy .env.example .env on Windows
docker-compose up -d
```
### Client Installation
```bash
$ git clone https://github.com/tfd-ed/tfd-nuxt-tailwind-boilerplate
$ cd tfd-nuxt-tailwind-boilerplate
$ yarn install
$ yarn dev
````
Visit http://localhost:3000/
### Production Guide
```bash
# build for production and launch server
$ yarn build
$ yarn start
# generate static project
$ yarn generate
```
### With Docker
Comming Soon!
## Donation
Kindly donate to the following bank account (Cambodia) if you want to support our works.
#### KHEANG KIM ANG
#### 001 821 043
You can also donate with **Visa Direct**.
#### 4026 4503 2163 1102