diff --git a/README.md b/README.md index 4c15716..eae2adc 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,28 @@ # iPet-api -## Table of Contents +## Sumário -- [Usage](#usage) -- [Contributing](../CONTRIBUTING.md) +- [Sobre](#about) +- [Dando início](#getting_started) +- [Construído com](#built_using) +- [Autores](#authors) +- [Referências](#references) +## 🧐 Sobre -### Prerequisites +Projeto da discplina de Programação em Microinformática com foco em gerenciamento e cuidados com Pets. + + +## 🏁 Dando início + +Para testar a aplicação localmente, siga os passos em "Instalação" + +### Pré-requisitos - Node - NPM -### Installing - -GALERA, NA PRIMEIRA VEZ QUE VOCÊS FOREM UTILIZAR, precisam clonar do github e instalar os pacotes +### Instalação Para clonar: @@ -33,8 +42,6 @@ Baixando pacotes: npm install ``` -Sempre que fizerem alguma mudança, é só salvar e vai atualizar direto, contanto que tenham inicado o server assim: - Iniciando servidor ``` @@ -45,4 +52,27 @@ Acessando essa URL pelo navegador vocês conseguem ver se ta funcionando: ``` http://localhost:3001/api -``` \ No newline at end of file + +``` + + +## ⛏️ Construído com: + +- [MongoDB](https://www.mongodb.com/) - Database +- [Express](https://expressjs.com/) - Server Framework +- [React Native](https://reactnative.dev) - Mobile Framework +- [Expo](https://expo.io) - Mobile Plataform +- [NodeJs](https://nodejs.org/en/) - Server Environment + +## ✍️ Autores + +- [@Thais Rabelo - Linkedin](https://www.linkedin.com/in/thaís-rabelo-823b401a3/) - Scrum Master/Front-end Development +- [@Eduardo Giudice - Linkedin](https://www.linkedin.com/in/eduardogiudice/) - Front-end Development +- [@Camila Pacheco - Linkedin](https://www.linkedin.com/in/camila-pacheco-aba39b1b2/) - Back-end Development +- [@João Pedro - Linkedin](https://github.com/Asfhen) - Front-end Development +- [@Renan Medeiros - Linkedin](https://www.linkedin.com/in/renan-alves-de-medeiros-ba956719a/) - Back-end Development +- [@Matheus Costa - Linkedin](https://www.linkedin.com/in/matheus-costa-500695187/) - Full Stack Development + +## Referências + +- [iPet-app](https://github.com/MatheusCoxxxta/ipet-app) - Repositório do App.