Vue.js template used by Highest

Website

• 🌈 How it works
• 💻 Development
  • Environment setup
  • Building the app
  • Linting and fixing files
  • Customizing configuration
• 📜 Credits
• 🔐 License

🌈 How it works

It's a really simple template built on top of Vue.js. It includes :

• Vuetify framework (Material Design components)
• Vue Router
• Vuex (stores)
• Service worker and PWA (offline usage)
• ESLint (code quality)

It's used by Highest and delivered for everyone to use for various web projects.

💻 Development

Environment setup

First of all, clone the repository from GitHub on your local machine : (this requires Git to be installed)

git clone https://github.com/highest-app/template.git  # Using HTTP
git clone git@github.com:highest-app/template          # Using SSH

Install the required dependencies using your favorite package manager :

npm install   # Using NPM
yarn install  # Using Yarn

Then, run the application using the serve command : (Make sure you installed Vue CLI on your system)

npm run serve  # Using NPM
yarn serve     # Using Yarn

A web server will start with hot reload enabled, perfect to develop.

Building the app

To get a built version of the application ready to be served by a HTTP server, use the build command :

npm run build  # Using NPM
yarn build     # Using Yarn

Files will be generated in the dist folder, and the entry point will be the index.html file.

Linting and fixing files

To lint the files and check for formatting, run the lint command :

npm run lint  # Using NPM
yarn lint     # Using Yarn

If a better formatting is available, new code will be written directly inside the concerned files.

Customizing configuration

If you want to customize the build configuration, check the Configuration Reference on the Vue CLI documentation.

📜 Credits

• Main libraries : VueJS, Vuetify
• Maintainer : Théo Vidal

🔐 License

This project is under the GNU GPL v3 license.

WARNING : this license is here as a placeholder for your project : the template itself is completely free, without any license !