-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
4516b46
commit fa9d603
Showing
1 changed file
with
10 additions
and
53 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,61 +1,18 @@ | ||
| # github-api | ||
| # Github API Interaction | ||
|
|
||
| GitHub Pages: https://joaohamerski.github.io/github-api/ | ||
|
|
||
| ## Tecnologias utilizadas | ||
| ## 🛠️ Tools | ||
| - Vue 3 (script setup). | ||
| - Vite | ||
| - TypeScript | ||
| - Pinia store para implementar notificações Toast. | ||
| - Pinia for Toast Notifications. | ||
| - TailwindCSS. | ||
| - DaisyUI como biblioteca de componentes para TailwindCSS. | ||
| - Eslint e Prettier. | ||
| - DaisyUI as UI components for TailwindCSS. | ||
| - Eslint and Prettier. | ||
|
|
||
| ## Preview | ||
| ### Tema escuro | ||
| ## 🔍 Preview | ||
| GitHub Pages: https://joaohamerski.github.io/github-api/ | ||
|
|
||
| ### Dark theme | ||
|  | ||
| ### Tema claro | ||
| ### Light theme | ||
|  | ||
|
|
||
| ## Recommended IDE Setup | ||
|
|
||
| [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 | ||
| ``` |