Skip to content

Latest commit

 

History

History
130 lines (90 loc) · 4.97 KB

README.pt.md

File metadata and controls

130 lines (90 loc) · 4.97 KB
Raw

App Logo

Notes

Um aplicativo da web para criar, editar e excluir notas pessoais.

home

Leia este documento em sua língua de preferência:

O Notes é um aplicativo da web que imita um gerenciador de anotações pessoais, permitindo ao usuário criar, editar e excluir notas. Todas as notas são salvas em uma instância do Firebase Firestore e cada usuário deve ser autenticado para usar este aplicativo. Os usuários podem criar uma conta ou se autenticar se já possuírem uma conta no aplicativo web.

Tecnologias utilizadas

  • React
    • React Router
    • Redux
  • npm
    • iconify
    • uuid
    • moment
  • Firebase
    • Firestore
    • Hosting
    • Authentication

Sumário

Instalação

  1. Certifique-se de ter instalado o NodeJS no seu computador
  2. Clone este repositório usando git
  3. Abra o terminal de sua preferência no diretório do repositório clonado
  4. Execute o comando npm install ou, para usuários yarn, utilize o comando yarn add para instalar todas as dependências do projeto
  5. Vá para src/firebase/init.js e adicione sua configuração do Firebase Firestore (gerada pelo Firebase)
  6. Execute o comando npm start ou, para usuários yarn, utilize o comando yarn start para executar o projeto no localhost

Voltar ao topo
Voltar ao sumário

Como usar

Para começar, acesse este link para abrir a aplicação na web (host no Firebase) Então, siga os passos abaixo:

  1. Registro

Todos os usuários devem se registrar antes de usar o Notes. Para isso, basta digitar o e-mail e a senha da sua conta na tela de login. Se você não possui uma, clique no link 'Não tenho uma conta' e inscreva-se.

signup

  1. Página principal

Após o registro, o usuário será redirecionado para a página principal. Aqui, o usuário pode executar a maioria das funcionalidades do aplicativo, como criar uma nova nota, clicando no botão gigante 'Adicionar nota' ou selecionando esta opção no menu da barra lateral à esquerda, além de editar uma uma nota existente simplesmente clicando nela.

notes-saved

creating-note

  1. Notas deletads

Quando um usuário exclui uma nota, ela é enviada para a lixeira. Lá, o usuário pode restaurar as notas excluídas ou removê-las permanentemente. Há também a possibilidade de ler notas excluídas, mas não de editá-las (é necessário restaurá-las primeiro).

view-deleted

  1. Funcionalidades adicionais

Além das funcionalidades principais do aplicativo, existem outras secundárias que podem melhorar a experiência do usuário. De filtros à seleção múltipla, o gerenciamento de notas se torna mais fácil e rápido.

  • Order by

    Ordena todas as notas por título, data de criação ou modificação

  • Filter

    Filtra as notas por sua cor, que podem ser alteradas na tela de edição

    orderby-and-filter

  • Multiselection

    A seleção múltipla permite ao usuário selecionar várias notas de uma só vez e excluí-las com apenas um clique

    multiselection

Voltar ao topo
Voltar ao sumário

Licença

MIT License

Copyright (c) 2020 GabrielMCavalcante

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Voltar ao topo
Voltar ao sumário

Sobre

Voltar ao topo
Voltar ao sumário