diff --git a/README.md b/README.md index 2a03b69..3b56039 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,61 @@ # Starter Webapp -Starter template for building Vue3 applications using Vite as the build tool. +Starter Webapp is a comprehensive starter template for developing Vue 3 applications with Vite. +Optimized for performance and ease of use, this template integrates a modern technology stack including: -It comes pre-configured with several essential dependencies that will help you get started with your project right away. +Perfect for both small and large scale projects within mFactory, this starter kit sets the foundation +for building high-quality, maintainable web applications. -### Development -Just run and visit http://localhost:3333 +## Features -```bash -pnpm dev -``` +- **Vue 3**: The Progressive JavaScript Framework. +- **Vite**: Next Generation Frontend Tooling. +- **TypeScript**: JavaScript with syntax for types. +- **SCSS**: Sassy CSS for styles. +- **Quasar**: High-performance Vue.js framework. +- **SSG**: Static Site Generation support. +- **PWA**: Progressive Web App capabilities. +- **WebfontDownload**: Efficient web font loading. +- **ESLint, Prettier, Oxlint**: Combined linting and formatting tools. +- **Pnpm**: Fast, disk space efficient package manager. + +## Prerequisites + +- [Node.js](https://nodejs.org/) (>=18.0.0) +- [pnpm](https://pnpm.io/) (>=9.0.0) + +## Getting Started + +1. **Clone the repository:** + ```sh + git clone https://github.com/mfactory-lab/starter-webapp.git + cd starter-webapp + ``` + +2. **Install dependencies:** + ```sh + pnpm install + ``` -### Build -To build the App, run +3. **Run the development server:** + ```sh + pnpm dev + ``` + Open your browser and visit [http://localhost:3333](http://localhost:3333). -```bash -pnpm build +## Building for Production + +To build the application for production, run: + +```sh +pnpm build:ssg ``` +This will create a `dist` directory with the production build. + +## Contributing + +If you have any suggestions or improvements, feel free to open an issue or create a pull request. We welcome contributions from the community! + +## License + +This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.