Skip to content

Commit bda201e

Browse files
committed
[docs] update readme
1 parent 81a729d commit bda201e

File tree

5 files changed

+170
-4
lines changed

5 files changed

+170
-4
lines changed

README.md

Lines changed: 170 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,173 @@
1-
# Projeto Labeddit Frontend
1+
<h1 align="center">Projeto Labeddit Frontend</h1>
2+
<div align="center">
23

3-
> Front-End do projeto Labeddit
4+
> Clique [aqui](https://github.com/amandapolari/labeddit-backend) para acessar repositório do Back-End do projeto Labeddit
45
5-
## Fluxograma das Páginas
6+
<!-- ![funcionamento-site-gif](./pokedex/src/assets/images/site.gif) -->
67

7-
![Fluxograma de Páginas](./labeddit/src/assets/images/flow_pages.png)
8+
Clique [**AQUI**]() para conferir o resultado final do site!
9+
10+
</div>
11+
12+
<p align="center">
13+
<span><strong>Tecnologias e Ferramentas utilizadas:</strong></span>
14+
<br>
15+
<a href="https://skillicons.dev">
16+
<img src="https://skillicons.dev/icons?i=js,react,github,git,figma,mui,styledcomponents" style="height: 25px;"/>
17+
</a>
18+
</p>
19+
20+
<p align="center"><strong>Status do Projeto:<br></strong> <i>Em construção</i> 🚧</p>
21+
22+
<!-- <i>Concluído</i> ✔ -->
23+
24+
## Índice
25+
26+
- [1. Resumo do Projeto](#1-resumo-do-projeto)
27+
- [2. Definição de Produto](#2-definição-de-produto)
28+
- [3. Lista de Funcionalidades](#3-lista-de-funcionalidades)
29+
- [4. Protótipo](#4-protótipo)
30+
- [5. Instalação](#5-instalação)
31+
- [6. Inicialização](#6-inicialização)
32+
- [7. Tecnologias e Ferramentas Utilizadas](#7-tecnologias-e-ferramentas-utilizadas)
33+
- [8. Requisitos do Projeto](#8-requisitos-do-projeto)
34+
- [9. Desenvolvedora](#9-desenvolvedora)
35+
36+
## 1. Resumo do Projeto
37+
38+
[🔝](#índice)<br>
39+
40+
O Labbedit é um projeto full-stack de conclusão de curso do bootcamp da Labenu. O projeto consiste em uma rede social na qual é possível se cadastrar, fazer login, criar, editar e excluir posts e comentários. Além disso há a possibilidade curtir ou descurtir posts e comentários de outros usuários.
41+
42+
## 2. Definição de Produto
43+
44+
[🔝](#índice)<br>
45+
O projeto Labeddit possui quatro páginas:
46+
47+
### Página de Login
48+
49+
Na página de login é possui digitar seu e-mail e sua senha (sendo possível mostrar e esconder como desejar) e entrar no sistema. Caso haja algum erro o usuário será notificado. Ainda nessa página é possivel ir até a página de cadastro caso ainda não tenha um e-mail cadastrado no sistema.
50+
51+
### Página de Cadastro
52+
53+
Nessa página o usuário pode criar sua conta fornecendo apenas um apelido, e-mail e senha. Sendo necessário concordar com os termos de política de privacidade. Caso haja algum erro o usuário será notificado. Ao realizar seu cadastro com sucesso o usuário é direcionada para feed.
54+
55+
### Página de Feed
56+
57+
Em feedpage o usuário vai encontrar uma caixa de texto para criar seu próprio post, com no mínimo um caracter, caso tente criar um post vazio será notificado sobre o erro. É nesta página que ficam todas as postagens de outros usuários nas quais é possível dar like ou dislike. E caso haja no feedpage um post do usuário que está logado ele é capaz de editar ou de excluir sua própria postagem. Há a possibilidade de fazer o Lougout clicando no botão superior direito. Ainda nessa página se o usuário desejar ver os comentários de um post é clicar na postagem que será redirecionada para a página de comentários.
58+
59+
### Página de Comentários
60+
61+
Na página principal você pode dar like no post em questão e acompanhar os comentários sobre o mesmo, podendo dar like ou dislike como preferir. É possível também adicionar o seu próprio comentário e caso haja um comentário criado pelo usuário logado no momento ele tem acesso à funcionalidade de editar e deletar o comentário. Além disso, para melhorar a experiência do usuário a página possui um botão para retornar ao feedpage. Ou se preferir fazer o logout do sistema clicando no botão superior direito.
62+
63+
## 3. Lista de Funcionalidades:
64+
65+
[🔝](#índice)<br>
66+
67+
O Labeddit oferece diversas funcionalidades aos usuários, inclusive um CRUD completo de posts e comentários:
68+
69+
- Cadastro de usuário
70+
- Login de usuário
71+
- Logout de usuário
72+
- Criação de post
73+
- Edição de post
74+
- Deleção de post
75+
- Criação de comentário
76+
- Edição de comentário
77+
- Deleção de comentário
78+
- Curtir comentário
79+
- Descurtir comentário
80+
- Curtir posts
81+
- Descurtir posts
82+
83+
## 4. Protótipo
84+
85+
[🔝](#índice)<br>
86+
O Design de app mobile first foi fornecido pela Labenu, se preferir acesso direto pelo Figma clique **[aqui](https://www.figma.com/file/Ks2VBBhW0tN4p9g2ZtZtXE/Projeto-Integrador-Labeddit?type=design&node-id=0%3A1&mode=design&t=2qjhW6dWtWzmEM15-1)**, ou então acompanhe as imagens abaixo:
87+
88+
### Login
89+
90+
![Login](./labeddit/src/assets/images/prot_login.png)
91+
92+
### Signup
93+
94+
![Signup](./labeddit/src/assets/images/prot_signup.png)
95+
96+
### Feedpage
97+
98+
![Feedpage](./labeddit/src/assets/images/prot_feedpage.png)
99+
100+
### CommentsPage
101+
102+
![CommentsPage](./labeddit/src/assets/images/prot_commentpage.png)
103+
104+
## Instalação
105+
106+
[🔝](#índice)<br>
107+
108+
### 5. Pré-requisitos:
109+
110+
Ter instalado:
111+
112+
- Node.js e o pacote npm
113+
114+
Caso não tenha instalado:
115+
116+
- Faça o download do Node nesse [link](https://nodejs.org/en) da versão LTS, instale na sua máquina e verifique a instalação com o comando:
117+
118+
```bash
119+
node -v
120+
```
121+
122+
- E para verificar a versão do npm:
123+
124+
```bash
125+
npm -v
126+
```
127+
128+
- Se rodando os dois últimos comandos vc obteve a versão do node e do npm, acesse a _raiz_ do projeto e então rode o seguinte comando:
129+
130+
```bash
131+
npm install
132+
```
133+
134+
## 6. Inicialização
135+
136+
[🔝](#índice)<br>
137+
138+
- Para rodar o projeto localmente rode o seguinte comando:
139+
140+
```bash
141+
npm run start
142+
```
143+
144+
## 7. Tecnologias e Ferramentas Utilizadas
145+
146+
[🔝](#índice)<br>
147+
O frontend do projeto labeddit foi construído com:
148+
149+
- Javascript
150+
- React
151+
- Axios
152+
- Styled-Components
153+
- Material UI
154+
- Figma
155+
156+
## 8. Requisitos do Projeto
157+
158+
[🔝](#índice)<br>
159+
160+
## Front-end
161+
162+
- [✔️] Respeitar o layout do Figma
163+
- [✔️] Uso do ReactJS
164+
- [ _ ] Site deployado
165+
- [✔️] Documentação README
166+
167+
## 9. Desenvolvedora
168+
169+
[🔝](#índice)<br>
170+
171+
Este projeto foi desenvolvido por:
172+
173+
**Amanda Polari** : [LinkedIn](https://www.linkedin.com/in/amandapolari/) | [GitHub](https://github.com/amandapolari)
44.2 KB
Loading
41.8 KB
Loading
28.5 KB
Loading
36.3 KB
Loading

0 commit comments

Comments
 (0)