@nuxt-js/package
Version:
nuxt js package
61 lines (46 loc) • 1.19 kB
Markdown
# Your Package Name
A brief description of your package.
## Installation
```bash
npm install your-package-name
```
## Usage
```typescript
import { yourFunction } from 'your-package-name';
// Example usage
yourFunction();
```
## Development
1. Clone the repository
2. Install dependencies:
```bash
npm install
```
3. Build the package:
```bash
npm run build
```
4. Run tests:
```bash
npm test
```
## Available Scripts
The package includes several shell scripts that can be run using npm:
- `npm run clean` - Cleans build artifacts (dist and coverage directories)
- `npm run setup` - Runs initial setup (install dependencies, build, and test)
- `npm run dev` - Development workflow (clean, build, and test)
- `npm run build` - Builds the package
- `npm run test` - Runs tests
- `npm run configure` - Configures Nuxt.js project with optional features:
- `-f` or `--firebase` - Adds Firebase support
- `-t` or `--tailwind` - Adds Tailwind CSS
- `-sh` or `--shadcn` - Adds ShadCN-Vue
Example:
```bash
# Configure with Firebase and Tailwind
npm run configure -- -f -t
# Configure with all features
npm run configure -- -f -t -sh
```
## License
MIT