Skip to content

Commit

Permalink
docs: add readme
Browse files Browse the repository at this point in the history
  • Loading branch information
BrettOrmsby committed Aug 14, 2023
1 parent 6111ff2 commit 8e30772
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 45 deletions.
46 changes: 3 additions & 43 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,46 +1,6 @@
# hyper-tagger
# Hyper Tagger

This template should help get you started developing with Vue 3 in Vite.
Need to tag your [Moxfield](https://www.moxfield.com/) deck? Want to save time? Don't have a computer with you? Try [this](https://brettormsby.github.io/hyper-tagger/)!

## Recommended IDE Setup
![Website example](mockup.png)

[VSCode](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.

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)`
2. Reload the VSCode window by running `Developer: Reload Window` from the command palette.

## Customize configuration

See [Vite Configuration Reference](https://vitejs.dev/config/).

## Project Setup

```sh
npm install
```

### Compile and Hot-Reload for Development

```sh
npm run dev
```

### Type-Check, Compile and Minify for Production

```sh
npm run build
```

### Lint with [ESLint](https://eslint.org/)

```sh
npm run lint
```
Binary file added mockup.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion src/App.vue
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
<HelpSection />
</div>
<div v-show="currentTab === 'Tagger'">
<h1 style="text-align: center;">
<h1 style="text-align: center">
<img :src="imageUrl" class="logo" />
Hyper Tagger
</h1>
Expand Down
2 changes: 1 addition & 1 deletion src/components/EnterDeck.vue
Original file line number Diff line number Diff line change
Expand Up @@ -261,7 +261,7 @@ const sortDeck = (deck: DeckCard[], scryfallCards: ScryfallCard[]): DeckCard[] =
"Battle",
"Land"
];
const getMainType = (card: ScryfallCard): string => {
const typeLine = card.type_line.split("")[0];
for (const type of mainTypes) {
Expand Down

0 comments on commit 8e30772

Please sign in to comment.