Skip to content

Commit 20561e7

Browse files
LinkofOriginLinkofOrigin
committed
Startin Vue.js
1 parent c97eac1 commit 20561e7

27 files changed

Lines changed: 5540 additions & 0 deletions

‎README.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
# Game Data Multi-Library
2+
23
A multi-language API library for pulling video game data and statistics.

‎libraries/vueJS/.gitignore‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Logs
2+
logs
3+
*.log
4+
npm-debug.log*
5+
yarn-debug.log*
6+
yarn-error.log*
7+
pnpm-debug.log*
8+
lerna-debug.log*
9+
10+
node_modules
11+
.DS_Store
12+
dist
13+
dist-ssr
14+
coverage
15+
*.local
16+
17+
/cypress/videos/
18+
/cypress/screenshots/
19+
20+
# Editor directories and files
21+
.vscode/*
22+
!.vscode/extensions.json
23+
.idea
24+
*.suo
25+
*.ntvs*
26+
*.njsproj
27+
*.sln
28+
*.sw?
29+
30+
*.tsbuildinfo
31+
32+
# Hide secret files
33+
*secrets*

‎libraries/vueJS/.vscode/extensions.json‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"recommendations": ["Vue.volar"]
3+
}

‎libraries/vueJS/README.md‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# Game Data Multi-Library - Vue
2+
3+
This library uses the standard Vue template as a foundation. See the details below for running the project.
4+
5+
You will also need to create a `secrets.json` file to store your API credentials. See the section below for more details.
6+
7+
## Recommended IDE Setup
8+
9+
[VS Code](https://code.visualstudio.com/) + [Vue (Official)](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur).
10+
11+
## Recommended Browser Setup
12+
13+
- Chromium-based browsers (Chrome, Edge, Brave, etc.):
14+
- [Vue.js devtools](https://chromewebstore.google.com/detail/vuejs-devtools/nhdogjmejiglipccpnnnanhbledajbpd)
15+
- [Turn on Custom Object Formatter in Chrome DevTools](http://bit.ly/object-formatters)
16+
- Firefox:
17+
- [Vue.js devtools](https://addons.mozilla.org/en-US/firefox/addon/vue-js-devtools/)
18+
- [Turn on Custom Object Formatter in Firefox DevTools](https://fxdx.dev/firefox-devtools-custom-object-formatters/)
19+
20+
## Customize configuration
21+
22+
See [Vite Configuration Reference](https://vite.dev/config/).
23+
24+
## Project Setup
25+
26+
```sh
27+
npm install
28+
```
29+
30+
### Compile and Hot-Reload for Development
31+
32+
```sh
33+
npm run dev
34+
```
35+
36+
### Compile and Minify for Production
37+
38+
```sh
39+
npm run build
40+
```
41+
42+
## Client Credentials
43+
44+
You will need to create a file for storing your client credentials. Typically these secrets would be handled through your server environment, but for basic testing you can create this secrets file to immediately test the library.
45+
46+
Reminder: DON'T COMMIT SECRETS TO VERSION CONTROL!
47+
48+
### Twitch Account for Authentication
49+
50+
IGDB is owned and operated by Twitch.tv. In order to authenticate with the api, you will need an active Twitch account and register a developer application with it to acquire a Client ID and Client Secret. See IGDB's documentation here for details: [IGDB Account Creation](https://api-docs.igdb.com/#account-creation)
51+
52+
### Create Secrets File
53+
54+
1. Create a `secrets.json` file at the project root.
55+
2. Add two fields called `clientId` and `clientSecret`.
56+
3. Set those values to their respective values from your Twitch Developer App.

‎libraries/vueJS/index.html‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!DOCTYPE html>
2+
<html lang="">
3+
<head>
4+
<meta charset="UTF-8">
5+
<link rel="icon" href="/favicon.ico">
6+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
7+
<title>Vite App</title>
8+
</head>
9+
<body>
10+
<div id="app"></div>
11+
<script type="module" src="/src/main.js"></script>
12+
</body>
13+
</html>

‎libraries/vueJS/jsconfig.json‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"compilerOptions": {
3+
"paths": {
4+
"@/*": ["./src/*"]
5+
}
6+
},
7+
"exclude": ["node_modules", "dist"]
8+
}

0 commit comments

Comments
 (0)