This is a landing page project built with Vue 3, Vite, Pinia and Vue Router. It uses webfontloader to load custom fonts and @iconify/vue to display icons. It also has TypeScript support and linting and formatting tools.
VSCode + Volar (and disable Vetur) + TypeScript Vue Plugin (Volar).
The following VSCode extensions are also recommended for this project:
- browserslist: An extension that provides syntax highlighting and validation for browserslist files.
- EditorConfig: An extension that helps maintain consistent coding styles across different editors and IDEs by using EditorConfig files.
- ESLint: An extension that integrates ESLint into VSCode and provides linting feedback and auto-fixing capabilities.
- Prettier: An extension that integrates Prettier into VSCode and provides code formatting on save or on demand.
To install the project, you need to have Node.js and npm installed on your machine. Then, clone this repository and run the following command in the project directory:
npm install
This will install all the dependencies listed in the package.json file.
To run the project in development mode, use the following command:
npm run dev
This will start a local server on port 5173 with hot reload enabled.
To build the project for production, use the following command:
npm run build
This will create a dist folder with the optimized and minified files for deployment.
To deploy the project to GitHub Pages, use the following command:
npm run deploy
This will push the contents of the dist folder to the gh-pages branch of your repository. Make sure you have set up GitHub Pages for your repository before deploying.
To preview the built project locally, use the following command:
npm run preview
This will start a local server on port 4173 with the built files.
To check the TypeScript types in your project, use the following command:
npm run type-check
This will run vue-tsc and report any type errors.
To lint your project files, use the following command:
npm run lint
This will run eslint and fix any linting errors.
To format your project files, use the following command:
npm run format
This will run prettier and format your files according to the rules specified in .prettierrc file.
This project is licensed under the MIT License - see the LICENSE file for details.
See Vite Configuration Reference for more options and details.