FiveM VueJS Boilerplate for building beautiful NUI-s without hassle of setting everything up

---

FiveM VueJS Boilerplate is a template for making your own NUI-s for FiveM using VueJS. It removes the hassle of setting everything up on your own and constantly dealing with errors and mistakes before you finally get it up and running. VueJS allows you to build out your NUI-s faster and it eases the logic implementation. With this boilerplate all you have to do is let your mind go wild and free on a creative spree and start making your own interface designs.

---

Key features

• Pinia state management pre-implemented with examples of usage
• Vuetify 3 pre-implemented with examples of usage
• Axios pre-implemented with examples of usage
• Client code pre-implemented with examples of usage
• Watch script pre-implemented for building out the site for ui_view in-game

---

Installation

Download the zip files or clone the repository:

git clone https://github.com/alenvalek/fivem-vuejs-boilerplate.git

Open the project in a terminal of your choice and change the working directory into the html folder:

cd ./html

Install the required node packages

npm install

After that you can modify the api file inside html/api/axios.js in case you're planning to rename the resource.
After that you are ready to start building out your dream NUI.

Development tips

Run the following command to develop using a live server ( in browser )

npm run dev

Run the following command to build out your project for use in game

npm run build

Run the following command to build out the project for use in game every time a change has occured ( keep in mind you still have to restart the resource on your server for the changes to take effect ) [RECOMMENDED]

npm run watch

---

Technologies

• Lua
• VueJS
• VuetifyJS
• Pinia
• Typescript

Contributing

If you want to contribute to a project and make it better, every help is welcome.

How to contribute

1. Fork the repo to your own personal GitHub
2. Clone the project to your own machine
3. Commit changes to your own branch
4. Push your work to your own branch
5. Submit a pull request so changes can be reviewed before the merge

NOTE: Be sure to merge the latest from "upstream" before making a merge request.

License and license summary

FiveM BoilerPlate is licensed under MIT License

MIT License

Copyright (c) 2023 Alen Valek

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.