The fivem-vuejs-boilerplate from alenvalek

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

Contributing

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

How to contribute

Fork the repo to your own personal GitHub
Clone the project to your own machine
Commit changes to your own branch
Push your work to your own branch
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.

Passing Data to Vue

I am trying to pass a table to my VUE app and for whatever reason, the table is showing as null in the vue app

Not sure if i am just doing something dump... but if you could look at it and advise i would be greatful

Client.lua function

function SendPlayerDataToApp()
   local playerID = PlayerPedId()
   -- print(playerID)
   local PlayerID = GetPlayerServerId(NetworkGetPlayerIndexFromPed(playerID))
   -- print(PlayerID)
   ESX.TriggerServerCallback('ejcscomp:getPlayerData', function(playerData)
      job = ESX.GetPlayerData().job.name
      grade = ESX.GetPlayerData().job.grade
      playerData.job.name = job
      playerData.job.grade = grade
      -- print(playerData.name)
      -- print(job)
      print(label)
      SendNUIMessage({
         type = 'setPlayerData',
         data = playerData
      })
   end,PlayerID)

Server.lua function

ESX.RegisterServerCallback('ejcscomp:getPlayerData', function(source, cb, PlayerID)
        print(PlayerID)
        local playerData = {}
        local xPlayer = ESX.GetPlayerFromId(PlayerID)
        -- print(xPlayer)
        playerData.id = PlayerID
        playerData.name = xPlayer.name
        playerData.job = {}
        cb(playerData)
    end)

Store

export default new Vuex.Store({
	state: {
		playerData: {},
	},
	getters: {
		playerData(state) {
			return state.playerData;
		},
	},
	mutations: {
		setplayerData(state, payload) {
			print("Player Data:")
			print(payload.data)
			state.playerData = payload.data;
		},
	},
	actions: {},
});

mapGetters

computed: {
		...mapGetters(["playerData"]),
	},

display

<div v-if="playerData">
					<div>PlayerID: {{ playerData.id}}</div>
					<div>PlayerName: {{ playerData.name}}</div>
					<div>Job: {{ playerData.job.name}}</div>
					<div>Rank: {{ playerData.job.rank}}</div>
				</div>

alenvalek / fivem-vuejs-boilerplate Goto Github PK

fivem-vuejs-boilerplate's Introduction

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

Key features

Installation

Development tips

Technologies

Contributing

How to contribute

License and license summary

fivem-vuejs-boilerplate's People

Contributors

Stargazers

Watchers

Forkers

fivem-vuejs-boilerplate's Issues

Recommend Projects

Recommend Topics

Recommend Org