Documentação geral

README.md

@@ -1,2 +1,61 @@
-# DevRadar
-Código da aplicação desenvolvida durante a Semana OmniStack 10.0
+<h1 align="center">
+    <img alt="DevRadar" title="DevRadar" src=".github/devradar.svg" />
+</h1>
+
+<h4 align="center">
+  🚀 Semana OmniStack 10.0
+</h4>
+
+<p align="center">
+  <img alt="Release" src="https://img.shields.io/github/v/release/oDallas/devradar">
+  <img alt="Repository size" src="https://img.shields.io/github/repo-size/oDallas/devradar">
+  <img alt="GitHub last commit" src="https://img.shields.io/github/last-commit/oDallas/devradar">
+  <img alt="License" src="https://img.shields.io/badge/license-MIT-brightgreen">
+</p>
+
+<p align="center">
+  <a href="#-tecnologias">Tecnologias</a>&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;
+  <a href="#-projeto">Projeto</a>&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;
+  <a href="#-como-contribuir">Como contribuir</a>&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;
+  <a href="#-licença">Licença</a>
+</p>
+
+<br>
+
+<img alt="Frontend" src=".github/web.gif" width="100%">
+
+<p align="center">
+  <img alt="Mobile" src=".github/app.gif" width="35%">
+</p>
+
+## 🚀 Tecnologias
+
+Esse projeto foi desenvolvido com as seguintes tecnologias:
+
+- [Node.js](https://nodejs.org/en/)
+- [React](https://reactjs.org)
+- [React Native](https://facebook.github.io/react-native/)
+- [Expo](https://expo.io/)
+
+## 💻 Projeto
+
+O DevRadar é um projeto que visa conectar desenvolvedores próximos a você que trabalham com as mesmas tecnologias.
+
+## 🤔 Como contribuir
+
+- Faça um fork desse repositório;
+- Cria uma branch com a sua feature: `git checkout -b minha-feature`;
+- Faça commit das suas alterações: `git commit -m 'feat: Minha nova feature'`;
+- Faça push para a sua branch: `git push origin minha-feature`.
+
+Depois que o merge da sua pull request for feito, você pode deletar a sua branch.
+
+## 📝 Licença
+
+Esse projeto está sob a licença MIT. Veja o arquivo [LICENSE](LICENSE.md) para mais detalhes.
+
+---
+
+<p align="center">
+  Agradecimento especial a <a href="https://rocketseat.com.br">Rocketseat</a> ♥
+</p>

backend/README.MD

@@ -1,6 +1,6 @@
-# DevRadar Backend
+# 🖥️ Backend
 
-## Instalação e execução
+## 💿 Instalação e execução
 
 Para configurar a **PORTA** do servidor ou o **PATH** do MongoDB, basta alterar o arquivo **.env**.
 
@@ -16,7 +16,7 @@ npm
 npm start
 ```
 
-## Rotas
+## 🛠️ Rotas
 
 ### Index
 

frontend/README.md

@@ -1,8 +1,8 @@
-# DevRadar Frontend
+# 📄 DevRadar Frontend
 
 O frontend da aplicação foi construído em NodeJs e ReactJs
 
-## Instalação e execução
+## 💿 Instalação e execução
 
 É preciso editar os arquivos **/src/services/api.js** e **/src/services/socket.js** com o **IP** e a **PORTA** do backend.
 

mobile/README.MD

@@ -1,8 +1,8 @@
-# DevRadar Mobile
+# 📱 DevRadar Mobile
 
 O Mobile da aplicação foi construído em Expo e React Native
 
-## Instalação e execução
+## 💿 Instalação e execução
 
 É preciso editar os arquivos **/src/services/api.js** e **/src/services/socket.js** com o **IP** e a **PORTA** do backend.