commit

Author: guillaumeduhan

README.md

@@ -1,46 +1,109 @@
-# Vue 3 Bootstrap Starter
-
-🦾 Starter boilerplate with Vue 3 & Bootstrap.
-📦 Vue 3, Bootstrap 5, Vue-Router, Pinia, Sass/Scss, ESLint
-⌚ Last update: 1/05/2024
-
-![logo](https://repository-images.githubusercontent.com/217154004/ba7dfb8c-9645-42ca-ad88-41f568fcfd36)
+# 🦾 Vue 3 Bootstrap Starter
+
+A modern boilerplate built with Vue 3 and Bootstrap 5. Includes Vue-Router, Pinia, Sass/SCSS, and ESLint — everything you need to kickstart your Vue project.
+
+![logo](https://repository-images.githubusercontent.com/217154004/65cb3cfd-023f-4035-821a-ca5bf92cd433)
+
+## ✨ Features
+
+- 📦 Vue 3 + Vite setup
+- 🛣️ Vue-Router for navigation
+- 🗂️ Pinia for state management
+- 🎨 Bootstrap 5 for responsive UI
+- 🎨 Sass/SCSS support
+- ✅ ESLint for code quality
+
+## 📁 Project Structure
+
+```plaintext
+├── public/
+│   └── index.html
+├── src/
+│   ├── assets/
+│   ├── components/
+│   ├── router/
+│   │   └── index.js
+│   ├── store/
+│   │   └── index.js
+│   ├── styles/
+│   │   └── main.scss
+│   ├── App.vue
+│   └── main.js
+├── package.json
+├── vite.config.js
+└── .eslintrc.js
+```
 
-## Getting Started
+## 🚀 Getting Started
 
-Clone project and enter in folder:
+### 1. Clone the Repository
 
-```
+```bash
+git clone https://github.com/your-username/vue-bootstrap-starter.git
 cd vue-bootstrap-starter
 ```
 
-Run npm install:
+### 2. Install Dependencies
 
-```
-npm i
+```bash
+npm install
+# or
+pnpm install
 ```
 
-Enjoy:
+### 3. Start the Development Server
 
-```
+```bash
 npm run serve
+# or
+pnpm dev
 ```
 
-## Built With
+The app will be available at [http://localhost:5173/](http://localhost:5173/).
+
+## 🎨 Customization
+
+- Update `src/styles/main.scss` to override Bootstrap variables and add custom styles.
+- Add new routes in `src/router/index.js`.
+- Manage global state with Pinia in `src/store/`.
+
+## 📦 Building for Production
+
+```bash
+npm run build
+# or
+pnpm build
+```
+
+The production-ready files will be generated in the `dist/` directory.
+
+## 🚀 Deployment
+
+Deploy the `dist/` directory to your preferred platform:
+
+- [Vercel](https://vercel.com/)
+- [Netlify](https://www.netlify.com/)
+- [GitHub Pages](https://pages.github.com/)
+- [Cloudflare Pages](https://pages.cloudflare.com/)
+
+## ❓ FAQ
+
+### Why use this starter?
+
+It combines Vue 3, Bootstrap 5, and Pinia with a ready-to-go structure for rapid development.
+
+### Can I replace Bootstrap?
 
-- [Vue CLI](https://cli.vuejs.org/) - Standard Tooling for Vue.js Development
-- [Vue-Router](https://router.vuejs.org/) - Vue Router is the official router for Vue.js.
-- [Pinia](https://router.vuejs.org/) - Pinia is the best state management for Vue.js.
-- [Bootstrap](https://getbootstrap.com/) - Build responsive, mobile-first projects on the web with the world’s most popular front-end component library.
+Yes, you can swap Bootstrap with TailwindCSS or another UI library by updating `main.scss`.
 
-## Versioning
+### Does it support TypeScript?
 
-We use [SemVer](http://semver.org/) for versioning.
+You can enable TypeScript by renaming `.js` files to `.ts` and updating `vite.config.js`.
 
-## Authors ✨
+## 👨‍💻 About the Creator
 
-- **guillaumeduhan** - _Initial work_ - [Github](https://github.com/guillaumeduhan)
+I'm Guillaume Duhan, CTO & indie builder. I've launched many projects using Vue, and this starter is a solid foundation for building modern Vue apps quickly.
 
-## License
+## 📎 License
 
-This project is licensed under the MIT License.
+This project is licensed under the [MIT](LICENSE).

makefile

@@ -0,0 +1,23 @@
+# Makefile by @codewithguillaume
+gt:
+	git add .
+	git commit -m "commit"
+	git push
+
+gtc:
+	git pull --no-ff
+	make gt
+
+gr:
+	git rebase main
+
+gm:
+	git switch main
+	git pull
+
+gmc:
+	make gm
+	git checkout -
+
+dev:
+	npm run dev