Skip to content

Latest commit

 

History

History
84 lines (50 loc) · 2.57 KB

README.md

File metadata and controls

84 lines (50 loc) · 2.57 KB
Raw

🚀 Quick Start

These instructions will help you set up a deployment as fast as possible. It is assumed that you have Node 16+ and pnpm installed.

  1. Clone the repo and install dependencies.

  2. Delete all images in images and replace with your own.

  3. Edit the configuration in gallery.config.ts

  4. Build Nuxt in static mode with npm run generate.

  5. Deploy the static build on hosting of your choosing. there are Github Actions available to build & deploy to Netlify.

💻 Local Development

Get started

git clone https://github.com/KristofVDB1/Anna-Kristof.git

cd gallery

npm install

Development mode

npm run dev

Important directories

  • images stores all your images
  • src
    • src/components
    • src/composables
    • src/pages
    • src/types

Commands Index:

see package.json

Here is a brief explanation of each command:

  • build: This script command builds the Nuxt.js application in a production environment.

  • dev: This script command starts a development server and watches for changes in the application.

  • generate: This script command generates the static version of the Nuxt.js application.

  • preview: This script command previews the application.

  • postinstall: This script command runs the nuxt prepare command after the project dependencies have been installed.

  • images: This script command generates the Nuxt.js application and copies the generated images to the src/public directory.

  • lint: This script command runs the ESLint linter on the project's TypeScript, JavaScript, and Vue.js files.

  • lint:fix: This script command runs the ESLint linter and automatically fixes any linting errors found in the project's TypeScript, JavaScript, and Vue.js files.

  • prettier: This script command checks the code format of the project's source files using Prettier.

  • prettier:fix: This script command checks the code format of the project's source files using Prettier and automatically fixes any formatting issues.

  • test:unit: This script command runs the unit tests for the project using Vitest.

  • test:e2e: This script command runs the end-to-end tests for the project using Playwright.

  • test:coverage: This script command runs the code coverage tests for the project using Vitest.

  • prepare: This script command installs the Husky library, which is used for Git hooks in the project.

License

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