Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
MatheusCoxxxta authored Jul 7, 2020
1 parent 155d2ab commit 278ada9
Showing 1 changed file with 40 additions and 10 deletions.
50 changes: 40 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -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 <a name = "about"></a>

### Prerequisites
Projeto da discplina de Programação em Microinformática com foco em gerenciamento e cuidados com Pets.


## 🏁 Dando início <a name = "getting_started"></a>

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:

Expand All @@ -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

```
Expand All @@ -45,4 +52,27 @@ Acessando essa URL pelo navegador vocês conseguem ver se ta funcionando:

```
http://localhost:3001/api
```
```


## ⛏️ Construído com: <a name = "built_using"></a>

- [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 <a name = "authors"></a>

- [@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 <a name = "references"></a>

- [iPet-app](https://github.com/MatheusCoxxxta/ipet-app) - Repositório do App.

0 comments on commit 278ada9

Please sign in to comment.