Skip to content

Latest commit

 

History

History
95 lines (61 loc) · 2.86 KB

README.md

File metadata and controls

95 lines (61 loc) · 2.86 KB

Ditey

Screenshot

Se quiser dar uma olhada em todas as screenshots, click aqui.

📌 Índice

⚙ Tecnologias

Esse projeto foi desenvolvido com as seguintes tecnologias:

💻 Projeto

Esse é o front-end do servidor ditey-api.

O Ditey é um leitor de textos que visa facilitar a vida das pessoas ao trabalharem com leitura, transcrição e anotação de textos. O Ditey permite que o usuário mantenha seus textos salvos no banco de dados, e mude a velocidade e a voz da fala. Por baixo dos panos, o Ditey usa a Web Speech API para fazer a leitura dos textos.

Observações

  • Devido a compatibilidade da Web Speech API, algumas funções do projeto podem não funcionar corretamente em alguns navegadores.

🔖 Layout

Você pode visualizar o layout do projeto através desse link. Lembrando que você precisa ter uma conta no Figma para poder interagir com os componentes do layout.

🚀 Instalação

Pré-requisitos

  • Ter Git para clonar o projeto.
  • Ter Node.js instalado.
  • Ter um gerenciador de pacotes como NPM ou Yarn para instalar as dependências do projeto.

Clonando o Repositório

git clone https://github.com/rodrigosuelli/ditey-web.git

cd ditey-web

Instalando as dependências

$ npm install

# ou

$ yarn

Conectando a aplicação com o servidor

Siga as instruções em ditey-api para iniciar o servidor e deixar ele rodando na sua máquina na porta (3333).

Executando o projeto

$ npm run start

# ou

$ yarn start

🤔 Como contribuir

  1. Faça um fork desse repositório
  2. Faça um clone do seu fork (git clone url-do-seu-fork && cd ditey-web)
  3. Crie uma branch com sua feature ou correção de bugs (git checkout -b minha-branch)
  4. Faça commit das suas alterações (git commit -m 'feature/bugfix: minhas alterações')
  5. Faça push para a sua branch (git push origin minha-branch)
  6. Abra sua Pull Request no repositório que você fez o fork

📝 Licença

Este projeto está licenciado sob a licença MIT.