-------------- --------------

CUTEVUE

An intuitive UI framework

Plain HTML/CSS/Javascript made from scratch!
Explore the docs »

View Demo · Report a Bug · Request a Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contributing
5. License
6. Contact
7. Acknowledgements

About The Project

There are many great UI frameworks available out there such as Vuetify, Bootstrap, Tailwind CSS, and etc. however, I didn't find one that really suit my needs so I created this one from scratch Because Why not 😄

Of course, no one framework will serve all projects' needs So I try adding more and more components in the near future. You may also suggest changes by forking this repo and creating a pull request or opening an issue. Thanks to all the people in advence who have contributed to expanding this framework!

Built With

This project started being a raw Vue/Nuxt template, then, I started Creating some reusable components from scratch.

Every project has got some default dependencies right out of the box when you install a Nuxt application(i.e. Corejs, Linter, Prettier, etc.); other than that, NO EXTRA DEPENDENCY IS USED

Getting Started

• If you're here then you're most likely know how to perform following actions.
• Make sure you got a text editor and a terminal, I recommend VS Code with the Vetur extension because of it being so lightweight.

Prerequisites

Before you run the project make sure you got node installed on your machine Here's the link

now it's time to install YARN package manager(cause I like it more 😅 )

npm install --global yarn

Installation

1. Fork the project

2. Clone the repo:

   git clone https://github.com/YOUR_USERNAME/cutevue.git

3. Open the folder in your text editor and then do:

   yarn install

   to install node_module packages and dependencies

4. Open nuxt.config.js and make sure to add all component directories:

     components: [
    '~/components/',
    '~/components/cutevue',
    '~/components/cutevue/icons'
    ]
   

5. Run the project:

     yarn dev

Usage

After running the project you can most likely visit projects first page at http://localhost:3000/ in your machine.

Navigate to all available tested components via the navDrawer in your right.

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

S.Mohammad Hosseininejad - smohammadhnd@gmail.com

• Instagram: @smohammdhn
• Telegram: @smohammdhn

Project Link: https://github.com/smohammadhn/cutevue

Acknowledgements

Amazing people who helped me make this happen:

• Saeid Hassani
• Alireza Beitari
• S.Hossein Mirhosseini