Skip to content

clemissile/clean-vuejs-starter

Repository files navigation

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

clean-vuejs-starter

A ✨ clean ✨ VueJs 3 project starter !

Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Contributing
  4. License
  5. Contact
  6. Acknowledgments

About The Project

There are many great VueJs starters available on GitHub; however, I didn't find one that really suited my needs so I created this enhanced one.

Built With

Getting Started

Prerequisites

  • npm
    npm install npm@latest -g

Installation

  1. Clone the repo
    git clone https://github.com/clemissile/clean-vuejs-starter.git
  2. Install NPM packages
    npm install
  3. Launch the project
    npm run serve

Prepare for production

npm run build

Prettier

This project use Prettier as code formatter. The format to use is defined in the .prettierrc.js file.

Prerequisites

Download and enable the Prettier extension for VS Code. You can find it just here.

Define Prettier as default formatter

Go to File > Preferences > Settings (or hit CTRL + , on Windows or COMMAND + , on macOS) and search for default formatter then select Prettier - Code formatter under Editor: Default Formatter.

Enable format on save

Go to File > Preferences > Settings (or hit CTRL + , on Windows or COMMAND + , on macOS) and search for format on save then ensure Editor: Format On Save is checked.

Congrats, you're ready to go ! Now, on each save, Prettier will format files for you.

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.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  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.md for more information.

Contact

Clemissile - @clemissile - ganivetclement@gmail.com

Project Link: https://github.com/clemissile/clean-vuejs-starter

Acknowledgments

About

A clean and simple VueJs starter for your projects.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published