https://github.com/jairodoni/ignite-timer
https://github.com/jairodoni/ignite-timer
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/jairodoni/ignite-timer
- Owner: jairodoni
- License: mit
- Created: 2023-07-12T22:45:51.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2023-07-16T02:07:45.000Z (almost 2 years ago)
- Last Synced: 2025-01-23T21:20:17.075Z (5 months ago)
- Language: TypeScript
- Size: 394 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](LICENSE.md)
Preview |
Projeto |
Layout |
Tecnologias |
Executando |
Referências |
Autor
## **💻 Projeto**
Um projeto desenvolvido durante o Bootcamp Ignite da Rocketseat, o projeto "Ignite Timer" é um projeto com base no metodo pomodoro, onde você dedica um periodo de tempo para trabalho e um intervalo de descanço.
---
## **🔖 Layout**
Você pode visualizar o layout do projeto no formato através [desse link](https://www.figma.com/file/kMRUTTszJ5XyX0ECRtSKhY/Ignite-Timer-(JD)?type=design&node-id=313%3A1874&mode=design&t=MJS7ZssyQrVnBAG9-1). Lembrando que você irá precisar ter uma conta no [Figma](http://figma.com/).
#### **Web**
---
## **💻 Tecnologias**
#### **Website** ([React][react])
- **[React][react]**
- **[Typescript][typescript]**
- **[Vite][vite]**
- **[Styled Components][styled_components]**
- **[React Hook Form][react_hook_form]**
- **[Zod][zod]**
- **[Immer][immer]**
- **[Date fns][date_fns]**
- **[Node v18.16.1][node]**
> \* Veja o arquivo [package.json](./package.json)
#### **Utilitários**
- Editor: **[Visual Studio Code][vscode]**
- Markdown: **[StackEdit][stackedit]**, **[Markdown Emoji][markdown_emoji]**
---
## **🚀 Como executar o projeto**
### Configurações Iniciais
Primeiro, você precisa ter o [NodeJS](https://nodejs.org/en/download/) instalado na sua máquina.
Se você estiver utilizando o **Linux**, você pode optar por instalar o **Node** através do gerênciador de versões [nvm] para caso seja nescessario alterar a sua versão do **Node** para uma versão mais antiga ou mais nova.
Você pode optar também por utilizar o **yarn** no lugar do **npm**. Você pode instalar clicando nesse [link][yarn].
Após ter o **Node** instalado, instale as dependências do **React** contidas nos arquivos `package.json` que se encontram na raíz do repositório. Para instalar as dependências, basta abrir o terminal no diretório e digitar o comando:
```sh
$ npm install
# ou
$ yarn
```
> Veja a parte de **scripts {}** do arquivo [package.json](./package.json) para saber quais scripts estão disponíveis.
### Executando o WebSite
```sh
# Executando o website no modo de desenvolvimento:
$ npm run dev
# ou
# Executando o website no modo de desenvolvimento:
$ yarn dev
```
> Se o browser não abrir automaticamente, acesse: http://localhost:5173.
---
## **📚 Referências**
- [Blog Rocketseat](https://blog.rocketseat.com.br/)
- [ReactJS](https://reactjs.org/docs/getting-started.html) | [ReactJS pt-BR](https://pt-br.reactjs.org/docs/getting-started.html)
- [Node](https://nodejs.org/en/)
## **👨🚀 Autor**
👋 Entre em contato!
[](https://www.linkedin.com/in/jairodoni/)
[](mailto:[email protected])
## **:memo: Licença**
Esse projeto está sob a licença MIT. Veja o arquivo [LICENSE](LICENSE.md) para mais detalhes.
[rocketseat_site]: https://rocketseat.com.br/
[repository_license_badge]: https://img.shields.io/github/license/JairoDoni/NLW-1.0
[web_react_badge]: https://img.shields.io/badge/web-react-blue
[typescript]: https://img.shields.io/badge/types-Typescript-blue
[react]: https://reactjs.org/
[vite]: https://vitejs.dev
[date_fns]: https://date-fns.org
[react_hook_form]: https://react-hook-form.com
[zod]: https://zod.dev
[styled_components]: https://styled-components.com
[immer]: https://immerjs.github.io/immer/
[node]: https://nodejs.org/en/
[nvm]: https://github.com/nvm-sh/nvm
[vscode]: https://code.visualstudio.com/
[react_native]: http://www.reactnative.com/
[stackedit]: https://stackedit.io
[markdown_emoji]: https://gist.github.com/rxaviers/7360908
[react_icons]: https://react-icons.github.io/react-icons/
[typescript]: https://www.typescriptlang.org/
[asdf]: https://github.com/asdf-vm/asdf
[yarn]: https://classic.yarnpkg.com/en/docs/install/#debian-stable
[webpack]: https://webpack.js.org
