API RESTful para cadatro de pessoa e consumo da mesma em aplicação VUE.

Sobre • Como está dividido o projeto • Tecnologias • Autor

💻 Sobre o projeto

API RESTful - É uma aplicação que foi desenvolvida para praticar a lógica de uma criação totalmente do zero, fazendo o front e back-end.

---

🚀 Como está dividido o projeto

Este projeto é divido em duas partes:

1. Back-end (pasta server)
2. Front-end (pasta web)

💡O Front-end precisa que o Back-end esteja sendo executado para funcionar.

Pré-requisitos

Antes de começar, você vai precisar ter instalado em sua máquina as seguintes ferramentas: Git, Node.js + NPM. Além disto é importante ter um bom editor para trabalhar com o código, sugiro o VSCode

Você também pode utilizar uma ferramenta para poder consumir a API backend, para esse projeto, utilizamos o Insomnia.

🎲 Rodando o Backend (servidor)

# Clone este repositório
$ git clone [email protected]:JacksonSantin/api-web-person.git

# Acesse a pasta do projeto no terminal/cmd
$ cd api-web-person

# Vá para a pasta server
$ cd server

# Instale as dependências
$ npm i

# Execute a aplicação em modo de desenvolvimento
$ npm start

# O servidor inciará na porta:3000 - acesse http://localhost:3000

🧭 Rodando a aplicação web (Frontend)

# Clone este repositório
$ git clone [email protected]:JacksonSantin/api-web-person.git

# Acesse a pasta do projeto no seu terminal/cmd
$ cd api-web-person

# Vá para a pasta da aplicação Front End
$ cd web

# Instale as dependências
$ npm i

# Execute a aplicação
$ npm run dev

# A aplicação será aberta na porta:3001 - acesse http://localhost:3001

---

🛠 Tecnologias

As seguintes ferramentas foram usadas na construção do projeto:

Web (Vue) + Vuetify)

• Axios

Veja o arquivo package.json

Backend (NodeJS + Javascript)

• Express
• CORS
• MongoDB
• SwaggerUI
• mongoose
• nodemon
• dotenv

Veja o arquivo package.json

Utilitários

• Editor: Visual Studio Code

---

👨‍💻 Contribuidores

Jackson Dhanyel Santin

💪 Como contribuir para o projeto

1. Faça um fork do projeto.
2. Crie uma nova branch com as suas alterações: git checkout -b my-feature
3. Salve as alterações e crie uma mensagem de commit contando o que você fez: git commit -m "feature: My new feature"
4. Envie as suas alterações: git push origin my-feature

---

🦸 Autor

Jackson Dhanyel Santin

---

📝 Licença

Este projeto esta sobe a licença MIT.

Feito com ❤️ por Jackson Dhanyel Santin 👋🏽 Entre em contato!

---