https://github.com/abhay-100/vueami
A clean, fast, and customizable portfolio template built with Vue.js
https://github.com/abhay-100/vueami
accessibility aos-animation font-awesome performance personal-website portfolio portfolio-template primeicons primeng primevue responsive tailwindcss vite vue3 vuejs
Last synced: about 1 month ago
JSON representation
A clean, fast, and customizable portfolio template built with Vue.js
- Host: GitHub
- URL: https://github.com/abhay-100/vueami
- Owner: ABHAY-100
- License: mit
- Created: 2024-07-30T16:49:41.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-05-05T14:33:00.000Z (about 1 year ago)
- Last Synced: 2025-08-19T14:36:51.851Z (10 months ago)
- Topics: accessibility, aos-animation, font-awesome, performance, personal-website, portfolio, portfolio-template, primeicons, primeng, primevue, responsive, tailwindcss, vite, vue3, vuejs
- Language: Vue
- Homepage: https://vueami.pages.dev
- Size: 6.42 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Vueami
A clean, fast, and highly customizable portfolio template built with [Vue.js 3](https://vuejs.org/), [PrimeVue](https://primevue.org/), and [Tailwind CSS](https://tailwindcss.com/).
Deploy your Vueami site with Vercel in minutes.
[](https://vercel.com/new/clone?repository-url=https://github.com/ABHAY-100/vueami)
## 🌟 Features
- **Modern Frameworks**: Built with Vue.js 3 using the Composition API.
- **Fast & Efficient**: Powered by Vite for blazing-fast builds and hot-reloading.
- **Beautiful UI**: Styled with Tailwind CSS and PrimeVue components.
- **Customizable**: Easily update content, assets, and styles to suit your needs.
## 🚀 Technologies Used
- **Framework**: [Vue.js 3](https://vuejs.org/) with Composition API
- **Build Tool**: [Vite](https://vitejs.dev/)
- **UI Components**: [PrimeVue](https://primevue.org/)
- **Icons**: [PrimeIcons](https://primevue.org/icons)
- **Styling**: [Tailwind CSS](https://tailwindcss.com/)
- **Deployment**: [Cloudflare](https://pages.cloudflare.com/)
## 🛠️ Getting Started
### Prerequisites
- Node.js (v16 or higher)
- npm
### Installation
```bash
# Clone the repository
git clone https://github.com/ABHAY-100/vueami.git
# Navigate to the project directory
cd vueami
# Install dependencies
npm install
```
### Development
```bash
# Start the development server
npm run dev
```
The development server will start at `http://localhost:5173/`
### Build for Production
```bash
# Build for production
npm run build
# Preview the production build
npm run preview
```
## 🎨 Customization
Most of the site content can be updated by editing the following:
- **Primary Content**: Edit `src/constants/index.js` to update most of the data and text.
- **Meta Data**: Modify `index.html` for metadata and other HTML-level customizations.
- **Assets**: Replace images and other media in the `src/assets/` directory.
Feel free to show your creativity and make this portfolio truly yours! 🎉
## 🤝 Contributing
We welcome contributions from the community! Whether it's fixing a bug, adding a feature, or improving documentation, we appreciate your effort.
### Steps to Contribute
1. **Fork the Repository**: Create your own copy of the project.
2. **Create a Branch**: Work on a new branch (`git checkout -b feature/amazing-feature`).
3. **Commit Your Changes**: Write clear commit messages (`git commit -m "Add amazing feature"`).
4. **Push to Your Branch**: Push your changes (`git push origin feature/amazing-feature`).
5. **Submit a Pull Request**: Open a pull request describing your changes.
Let your creativity shine, and let's build something amazing together! 🚀
## 📜 License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
**Thank you for your interest in Vueami! 🤝**