/nuxt3-starter-template

A feature-rich Nuxt 3 starter template that integrates Firebase for backend functionality, Lucide for icons, Radix Vue for UI components, GSAP for animations, and TailwindCSS for styling. This template is designed to help you quickly bootstrap your next Nuxt 3 project with modern tools and best practices.

Primary LanguageTypeScript

Great! Let's structure your README.md file for your Nuxt 3 starter template with the provided details.

Nuxt 3 Starter Template

A feature-rich Nuxt 3 starter template that integrates Firebase for backend functionality, Lucide for icons, Radix Vue for UI components, GSAP for animations, and TailwindCSS for styling. This template is designed to help you quickly bootstrap your next Nuxt 3 project with modern tools and best practices.

Features

  • Nuxt 3: The latest version of Nuxt for a robust and efficient framework.
  • Firebase: Backend services including authentication, firestore, and hosting.
  • Lucide Icons: Beautifully designed open-source icons.
  • Radix Vue: Unstyled, accessible components for building high-quality UI.
  • GSAP: Powerful JavaScript library for creating animations.
  • TailwindCSS: Utility-first CSS framework for rapid UI development.

Installation

  1. Clone the repository:

    git clone https://github.com/kromate/nuxt3-starter-template.git
cd nuxt3-starter-template

  2. Install dependencies:

    npm install

  3. Set up Firebase:

    • Create a Firebase project in the Firebase Console.
    • Add your Firebase configuration to nuxt.config.ts or .env file.

  4. Run the development server:

    npm run dev

Usage

  1. Starting the development server:

    npm run dev

  2. Building for production:

    npm run build
npm run start

  3. Deploying to Firebase Hosting:

    npm run generate
firebase deploy

Project Structure

|--src
   ├── components
   ├── assets
   ├── layouts
   ├── pages
   ├── plugins
   ├── public
   ├── static
   ├── store
   ├── nuxt.config.ts
   ├── package.json
   ├── tailwind.config.js
   └── README.md

Contributing

Contributions are welcome! Please follow these steps to contribute:

  1. Fork the repository.
  2. Create a new branch: git checkout -b feature/your-feature-name.
  3. Commit your changes: git commit -m 'Add some feature'.
  4. Push to the branch: git push origin feature/your-feature-name.
  5. Open a pull request.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contact

For support or inquiries, please reach out to your-email@example.com.

Acknowledgments

Feel free to customize this README.md file further to match your specific needs. Let me know if you need any additional sections or modifications!