Skip to content

ankit-agarwal-xx/nuxt-dojo

Repository files navigation

netlify webpage: https://vocal-valkyrie-f4a319.netlify.app/

Nuxt Dojo

Nuxt Dojo is a web application built with Nuxt.js, a Vue.js framework for building universal applications. This project serves as a starter template for developing Nuxt.js applications, showcasing various features and best practices.

Features

  • Server-side rendering (SSR) for improved performance and SEO
  • Vue.js single-file components for modular and reusable code
  • Routing with Nuxt.js's powerful routing system
  • Vuex store for managing application state
  • Axios for making HTTP requests
  • SCSS preprocessor for styling
  • ESLint and Prettier for code linting and formatting

Getting Started

Prerequisites

Make sure you have the following software installed on your machine:

  • Node.js (version 12 or higher)
  • npm (or yarn)

Installation

  1. Clone the repository:

    git clone https://github.com/AnkitxxChici/nuxt-dojo.git
  2. Navigate to the project directory:

    cd nuxt-dojo
  3. Install the dependencies:

    npm install
  4. Start the development server:

    npm run dev

    The application will be accessible at http://localhost:3000.

Folder Structure

The repository's folder structure is organized as follows:

  • assets: Contains static assets like images and stylesheets.
  • components: Contains Vue.js components that are used across the application.
  • layouts: Contains application layouts, which define the overall structure of the pages.
  • pages: Contains the application's pages and routes.
  • plugins: Contains custom plugins for extending Nuxt.js functionality.
  • store: Contains the Vuex store modules for managing application state.
  • static: Contains static files that will be served as-is.
  • middleware: Contains custom middleware functions for routing.
  • nuxt.config.js: Configuration file for Nuxt.js.

Contributing

Contributions are welcome! If you have any ideas, suggestions, or bug reports, please open an issue or submit a pull request.

License

This project is licensed under the MIT License.

Acknowledgments

This project was inspired by the official Nuxt.js documentation and various Nuxt.js example projects.

Nuxt 3 Minimal Starter

Look at the Nuxt 3 documentation to learn more.

Setup

Make sure to install the dependencies:

# npm
npm install

# pnpm
pnpm install

# yarn
yarn install

Development Server

Start the development server on http://localhost:3000:

# npm
npm run dev

# pnpm
pnpm run dev

# yarn
yarn dev

Production

Build the application for production:

# npm
npm run build

# pnpm
pnpm run build

# yarn
yarn build

Locally preview production build:

# npm
npm run preview

# pnpm
pnpm run preview

# yarn
yarn preview

Check out the deployment documentation for more information.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published