Readme Legal
Uma readme bonita, pratica e eficiente para usar em todos projeto e padronizar as readmes.
🧩 Introdução | 🚀 Resultados | 🧪 Dependências | 💡 Possíveis Melhorias | 🏆 Créditos
⠀⠀⠀⠀Bem-vindo ao meu projeto de padronização 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 necessários e padroniza a apresentação de informações importantes.
Todos os resultados foram alcançados com sucesso. De modo geral são esses os resultados de cada requisição.
⠀⠀⠀⠀⭐ Basta arrastar a imagem desseja para a readme copiar a url e substituir a imagem antiga pela nova
⭐ Login | ⭐ Registro | ⭐ Feed | ⭐ Menu |
---|---|---|---|
![]() |
![]() |
![]() |
![]() |
⭐ Login | ⭐ Registro | ⭐ Feed |
---|---|---|
![]() |
![]() |
![]() |
⠀⠀⠀⠀⭐ Caso seu projeto seja um backend Aqui tem uma boa forma de demostra como que faz as requisições e oque retorna
https://localhost:3003/users/perfil
{
"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"
},...
}
https://localhost:3003/users/register
{
"name": "teste",
"email": "[email protected]",
"password": "123456"
}
https://localhost:3003/users/login
{
"email": "[email protected]",
"password": "123456"
}
https://localhost:3003/posts
[
{
"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"
},...
]
https://localhost:3003/posts
{
"idUser": "f27d54fd-2edb-4653-af60-bb311a00a5b3",
"texto": "olha eu kkkkk",
"img": "Tem como mandar a imagem do pc ou mandar url da imagem, por padrão só tem como manda do pc"
}
Requisitos para rotar o codigo...
Caso tenha Git basta da git clone, caso não tenha baixe o projeto completo em dowlon
git clone https://github.com/MayconCoutinho/Readme-GitHub
Caso já tenha o Node em sua maquina basta instalar o projeto com npm i
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"
}
Possíveis melhorias no código e no projeto, caso queira voltar e melhorá lo.
- - Testa todo o código.
- - Pesquisar o perfil com nome
- ***- ***
- ***- ***
Todo o projeto foi feito por...
![]() Maycon Coutinho |
Hello 😃 Se você chegou até aqui, acredito que gostou do meu projeto, nesse caso temos algo em comum, sendo assim que tal conversamos um pouco? Meu chama no linkedin 😁 |
---|