Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/takumayumi/vuefolio
Babel | ESLint | SASS | Typescript | Vite | Vue.js | Vuetify
https://github.com/takumayumi/vuefolio
babel eslint sass typescript vite vue-js vuetify
Last synced: 26 days ago
JSON representation
Babel | ESLint | SASS | Typescript | Vite | Vue.js | Vuetify
- Host: GitHub
- URL: https://github.com/takumayumi/vuefolio
- Owner: takumayumi
- License: apache-2.0
- Created: 2024-06-17T11:07:36.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-07-02T03:23:50.000Z (4 months ago)
- Last Synced: 2024-09-29T02:23:36.823Z (about 1 month ago)
- Topics: babel, eslint, sass, typescript, vite, vue-js, vuetify
- Language: Vue
- Homepage:
- Size: 4.5 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# vuefolio
## Overview
This is a project portfolio built with Vue.js. It showcases various projects and skills, providing an interactive and user-friendly interface.
## Features
### Light and Dark Mode
This portfolio supports both light and dark modes for better readability and user preference. The initial mode is set based on the user's system preference detected by the browser. Users can switch between modes easily by clicking on the bulb toggle button. Their preference is saved locally using localStorage, ensuring a consistent experience across visits.
## Tools and Technologies Used
- **Babel**: JavaScript compiler for converting modern JavaScript into backward-compatible versions.
- **ESLint**: Pluggable JavaScript linter for code quality and best practices.
- **SASS**: Syntactically Awesome Style Sheets, used for styling.
- **TypeScript**: Typed superset of JavaScript that compiles to plain JavaScript.
- **Vite**: Next-generation front-end tool for faster and leaner development experience.
- **Vue.js**: Front-end JavaScript framework for building user interfaces.
- **Vuetify**: Material Design component framework for Vue.js.
## Getting Started
Follow these instructions to set up and run the project on your local machine.
### Prerequisites
Make sure you have Node.js and npm installed on your system. You can download them from [Node.js official website](https://nodejs.org/).
### Project Setup
1. Clone the repository:
```bash
git clone https://github.com/takumayumi/veufolio.git
cd veufolio
```
2. Install the dependencies:
```bash
npm install
```
### Development
To run the project in development mode with hot-reloading:
```bash
npm run serve
```
This will start a local server. Open your browser and navigate to http://localhost:8080 to see the application in action.
### Production
To compile and minify the project for production:
```bash
npm run build
```
### Linting
To lint and fix files:
```bash
npm run lint
```
This ensures that your code follows the defined style guidelines.
### Configuration
For more details on how to configure this project, see the Vue CLI Configuration Reference.
### Deployment
For deployment instructions, refer to the Vue CLI Deployment Guide.
## Credits
- Images: The other images used in this portfolio are from [Freepik](https://www.freepik.com/).
## Learning
You are welcome to download and use this project for your learning purposes. Please note that while you can use the code to understand and build your own projects, refrain from using my images.
## Contributing
If you would like to contribute to this project, please fork the repository and create a pull request. We appreciate any contributions, whether it's bug fixes, feature enhancements, or documentation improvements.
## License
This project is licensed under the MIT License. See the [LICENSE](https://raw.githubusercontent.com/takumayumi/veufolio/main/LICENSE) file for more details.
## Contact
For any questions or feedback, please open an issue on this repository.