Readme
Readme Legal
Uma readme bonita, pratica e eficiente para usar em todos projeto e padronizar as readmes.
Introducao | Resultados | Dependencias | Possiveis Melhorias | Creditos
PROJETO EM ANDAMENTO
Introducao
Bem-vindo ao meu projeto de padronizacao de READMEs no GitHub! Ao longo dos anos, percebi que muitos dos meus projetos no GitHub tinham READMEs inconsistentes e mal formatados. Para resolver esse problema, desenvolvi um modelo de README que atende a todos os requisitos necessarios e padroniza a apresentacao de informacoes importantes.
Resultados
Todos os resultados foram alcancados com sucesso. De modo geral sao esses os resultados de cada requisicao.
Front-end
Basta arrastar a imagem desseja para a readme copiar a url e substituir a imagem antiga pela nova
| Login | Registro | Feed | Menu |
|---|---|---|---|
Desktop
| Login | Registro | Feed |
|---|---|---|
Back-end
Caso seu projeto seja um backend Aqui tem uma boa forma de demostra como que faz as requisicoes e oque retorna
PEGAR TODOS OS DADOS DE UM USER ATRAVES DO ID
GET
{
"authorization" : "aa670248-dbd3-402c-a824-c52646fc1196"
}
"user": {
"id": "62f7daf9-d523-4b2d-b0cd-94039c5c4082",
"imgPerfil": "https://ovicio.com.br/wp-content/uploads/2020/09/20200916-d9ffbeb5e7862a243ce822bb89d12b66_750x750-555x555.jpg",
"name": "Toshinori",
"rgb": [
57,
82,
65
]
},
"post": [
{
"img": "https://firebasestorage.googleapis.com/v0/b/rede-social-203d0.appspot.com/o/feed%2F1676760852632.webp?alt=media&token",
"texto": "Outro",
"rgb": [
57,
82,
65
],
"id": "322ea0a3-1657-4ad1-8f75-4a95a2832394",
"date": "18/02/2023, 19:54:14",
"idUserLike": null,
"imgPerfil": "https://ovicio.com.br/wp-content/uploads/2020/09/20200916-d9ffbeb5e7862a243ce822bb89d12b66_750x750-555x555.jpg",
"name": "Toshinori",
"idUser": "62f7daf9-d523-4b2d-b0cd-94039c5c4082"
},...
}
REGISTRA UM USUARIO NO BANCO DE DADOS.
POST
"name": "teste",
"email": "teste@gmail.com",
"password": "123456"
}
FAZ LOGIN
POST
"email": "teste@gmail.com",
"password": "123456"
}
PEGA TODOS OS POSTS
GET
{
"id": "ed66e018-666f-40e9-a16f-510848491842",
"date": "18/02/2023, 19:56:17",
"img": "https://firebasestorage.googleapis.com/v0/b/rede-social-203d0.appspot.com/o/feed%2F1676760975303.jpg?alt=media&token",
"idUser": "f27d54fd-2edb-4653-af60-bb311a00a5b3",
"name": "Asui",
"idUserLike": null,
"rgb": [
73,
168,
126
],
"imgPerfil": "https://i.pinimg.com/originals/3a/2e/9a/3a2e9ab1fbf688f75f9227cc3c66951a.jpg",
"texto": "E vai indo"
},...
]
FAZ LOGIN
POST
"idUser": "f27d54fd-2edb-4653-af60-bb311a00a5b3",
"texto": "olha eu kkkkk",
"img": "Tem como mandar a imagem do pc ou mandar url da imagem, por padrao so tem como manda do pc"
}
Volta ao Sumario
Dependencias
Requisitos para rotar o codigo...
Instalacao
Caso tenha Git basta da git clone, caso nao tenha baixe o projeto completo em dowlon
Caso ja tenha o Node em sua maquina basta instalar o projeto com npm i
Scripts
"dev": "next dev",
"build": "next build",
"start": "next start",
"lint": "next lint",
"prepare": "husky install"
}
Dependencies
"axios": "^0.27.2",
"next": "12.2.5",
"react": "18.2.0",
"react-dom": "18.2.0",
"sass": "^1.54.8"
}
devDependencies
"@commitlint/cli": "^17.6.1",
"@commitlint/config-conventional": "^17.6.1",
"eslint": "^8.38.0",
"eslint-config-airbnb": "^19.0.4",
"eslint-config-google": "^0.14.0",
"eslint-config-next": "12.2.5",
"eslint-config-prettier": "^8.8.0",
"eslint-plugin-import": "^2.27.5",
"eslint-plugin-jsx-a11y": "^6.7.1",
"eslint-plugin-prettier": "^4.2.1",
"eslint-plugin-react": "^7.32.2",
"eslint-plugin-react-hooks": "^4.6.0",
"husky": "^8.0.3",
"prettier": "^2.8.7"
}
Volta ao Sumario
Possiveis Melhoras
Possiveis melhorias no codigo e no projeto, caso queira voltar e melhora lo.
- - Testa todo o codigo.
- - Pesquisar o perfil com nome
- ***- ***
- ***- ***
Volta ao Sumario
Creditos
Todo o projeto foi feito por...
Maycon Coutinho |
Hello Se voce chegou ate aqui, acredito que gostou do meu projeto, nesse caso temos algo em comum, sendo assim que tal conversamos um pouco? Meu chama no linkedin |
|---|