Skip to content

Commit

Permalink
cleaning up (#8)
Browse files Browse the repository at this point in the history
* lint

* payonce goodness
  • Loading branch information
TheMarstonConnell authored Feb 15, 2024
1 parent 9aea4ae commit bd051c9
Show file tree
Hide file tree
Showing 26 changed files with 565 additions and 318 deletions.
1 change: 0 additions & 1 deletion .eslintrc.cjs
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
/* eslint-env node */
require('@rushstack/eslint-patch/modern-module-resolution')

module.exports = {
root: true,
'extends': [
Expand Down
21 changes: 15 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,27 @@
# Vue 3 + TypeScript + Vite

This template should help get you started developing with Vue 3 and TypeScript in Vite. The template uses Vue 3 `<script setup>` SFCs, check out the [script setup docs](https://v3.vuejs.org/api/sfc-script-setup.html#sfc-script-setup) to learn more.
This template should help get you started developing with Vue 3 and TypeScript in Vite. The template uses Vue
3 `<script setup>` SFCs, check out
the [script setup docs](https://v3.vuejs.org/api/sfc-script-setup.html#sfc-script-setup) to learn more.

## Recommended IDE Setup

- [VS Code](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur) + [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin).
- [VS Code](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (
and disable
Vetur) + [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin).

## Type Support For `.vue` Imports in TS

TypeScript cannot handle type information for `.vue` imports by default, so we replace the `tsc` CLI with `vue-tsc` for type checking. In editors, we need [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin) to make the TypeScript language service aware of `.vue` types.
TypeScript cannot handle type information for `.vue` imports by default, so we replace the `tsc` CLI with `vue-tsc` for
type checking. In editors, we
need [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin)
to make the TypeScript language service aware of `.vue` types.

If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has also implemented a [Take Over Mode](https://github.com/johnsoncodehk/volar/discussions/471#discussioncomment-1361669) that is more performant. You can enable it by the following steps:
If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has also implemented
a [Take Over Mode](https://github.com/johnsoncodehk/volar/discussions/471#discussioncomment-1361669) that is more
performant. You can enable it by the following steps:

1. Disable the built-in TypeScript Extension
1. Run `Extensions: Show Built-in Extensions` from VSCode's command palette
2. Find `TypeScript and JavaScript Language Features`, right click and select `Disable (Workspace)`
1. Run `Extensions: Show Built-in Extensions` from VSCode's command palette
2. Find `TypeScript and JavaScript Language Features`, right click and select `Disable (Workspace)`
2. Reload the VSCode window by running `Developer: Reload Window` from the command palette.
30 changes: 15 additions & 15 deletions index.html
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
<!doctype html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<link rel="icon" type="image/svg+xml" href="/icon.svg" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Beacon - ALPHA</title>
<head>
<meta charset="UTF-8" />
<link rel="icon" type="image/svg+xml" href="/icon.svg" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Beacon - ALPHA</title>

<meta property="og:image" content="/banner.webp">
<meta property="og:title" content="Beacon">
<meta property="og:type" content="article" />
<meta property="og:description" content="Beacon is a decentralized publishing platform.">
<meta name="twitter:card" content="summary_large_image">
<meta property="og:image" content="/banner.webp">
<meta property="og:title" content="Beacon">
<meta property="og:type" content="article" />
<meta property="og:description" content="Beacon is a decentralized publishing platform.">
<meta name="twitter:card" content="summary_large_image">

</head>
<body>
<div id="app"></div>
<script type="module" src="/src/main.ts"></script>
</body>
</head>
<body>
<div id="app"></div>
<script type="module" src="/src/main.ts"></script>
</body>
</html>
8 changes: 4 additions & 4 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@
"dependencies": {
"@ckeditor/ckeditor5-vue": "^5.1.0",
"@jackallabs/ck5-custom": "file:jackallabs-ck5-custom-0.0.0.tgz",
"@jackallabs/jackal.js": "^2.2.0",
"@jackallabs/jackal.js": "^2.3.0",
"vite-plugin-node-stdlib-browser": "^0.2.1",
"vue": "^3.3.4",
"vue-router": "^4.1.6"
Expand Down
38 changes: 19 additions & 19 deletions public/icon.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
19 changes: 18 additions & 1 deletion public/vite.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
24 changes: 12 additions & 12 deletions src/App.vue
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<template>
<NavBar />
<span id="jackal-logo"><img id="beacon-logo-footer" width="14" height="14" src="/public/icon.svg"/>Made by Jackal Labs</span>
<span id="jackal-logo"><img id="beacon-logo-footer" width="14" height="14" src="/public/icon.svg" />Made by Jackal Labs</span>
<router-view />
</template>

Expand All @@ -17,20 +17,20 @@
</script>

<style lang="scss">
@import '@/assets/css/style.css';
@import '@/assets/css/ck.css';
@import '@/assets/css/style.css';
@import '@/assets/css/ck.css';
#jackal-logo {
text-align: left;
position: fixed;
left: 12px;
bottom: 4px;
}
#jackal-logo {
text-align: left;
position: fixed;
left: 12px;
bottom: 4px;
}
#beacon-logo-footer {
margin-right: 8px;
}
#beacon-logo-footer {
margin-right: 8px;
}
</style>
Loading

0 comments on commit bd051c9

Please sign in to comment.