Idleon-Companion / IdleonCompanion

Everything you'll ever need for Legends of Idleon!
https://idleoncompanion.com
35 stars 30 forks source link
firebase typescript vue

Idleon Companion Build

A companion website for the game Legends of Idleon.

Test website updated with this repo can be found here.

Features

Contributing

Find an issue posted in the issues tab in the repository, and then write a comment that you will be working on the feature/changes. Once you are finished, make sure that your branch is up to date with the master branch, and create a new Pull Request (PR). Your PR will be reviewed before merge!

Vue 3 + Typescript + Vite

To run the project, download yarn with npm install -g yarn

and then run the following:
yarn - install dependencies
yarn dev - run in localhost

Recommended IDE Setup

VSCode + Vetur. Make sure to enable vetur.experimental.templateInterpolationService in settings!

Type Support For .vue Imports in TS

Since TypeScript cannot handle type information for .vue imports, they are shimmed to be a generic Vue component type by default. In most cases this is fine if you don't really care about component prop types outside of templates. However, if you wish to get actual prop types in .vue imports (for example to get props validation when using manual h(...) calls), you can use the following:

If Using Vetur

  1. Install and add @vuedx/typescript-plugin-vue to the plugins section in tsconfig.json
  2. Delete src/shims-vue.d.ts as it is no longer needed to provide module info to Typescript
  3. Open src/main.ts in VSCode
  4. Open the VSCode command palette
  5. Search and run "Select TypeScript version" -> "Use workspace version"