Overview

The Nuxt3 + CodyHouse starter is a boilerplate template that allows users to kick off their projects quickly. It includes the main Nuxt 3 configuration files needed to create a fast and efficient app using the Vue app generator. The template also integrates the CodyFrame CSS framework, making it easy to include CodyHouse components in the project.

Features

• Quick development setup with the main Nuxt 3 configuration files
• Integration of the CodyFrame CSS framework for easy inclusion of CodyHouse components
• Real-time browser updates for efficient editing
• Example CodyHouse “confetti button” component included for demonstration
• Preprocessing of CodyHouse SCSS files for styling
• Separate directories for assets, components, layouts, and pages for organized project structure
• Optional inclusion of pages directory to reduce bundle size if not using vue-router
• Public directory for serving public files and global scripts used by CodyHouse components
• Nuxt configuration file for customizing project settings
• Manifest file for managing Node.js packages

Installation

To get started with the Nuxt3 + CodyHouse starter, follow these steps:

1. Clone this repository.
2. Open the cloned directory in your preferred code editor.
3. Navigate to the pages/index.vue file and edit it according to your needs.
4. Start the development server by running the command npm run dev in your terminal.
5. Access your site in your browser at http://localhost:3000.
6. To remove the example CodyHouse “confetti button” component, follow the provided removal instructions.

Summary

The Nuxt3 + CodyHouse starter is a convenient boilerplate template for starting Nuxt 3 projects. With its pre-configured Nuxt setup and integration of the CodyFrame CSS framework, developers can quickly set up a project and easily include CodyHouse components. The provided example component and organized directory structure further enhance the development process.