Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jacksonsantin/api-web-person
Criado uma API para salvar Pessoa, em node.js, e criada a tela em vue.js
https://github.com/jacksonsantin/api-web-person
api axios dotenv express mongodb mongoose nodejs swagger swagger-ui vue3 vuetify3
Last synced: 14 days ago
JSON representation
Criado uma API para salvar Pessoa, em node.js, e criada a tela em vue.js
- Host: GitHub
- URL: https://github.com/jacksonsantin/api-web-person
- Owner: JacksonSantin
- License: mit
- Created: 2023-06-14T20:54:46.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-07-27T12:37:08.000Z (over 1 year ago)
- Last Synced: 2024-11-18T04:45:02.875Z (3 months ago)
- Topics: api, axios, dotenv, express, mongodb, mongoose, nodejs, swagger, swagger-ui, vue3, vuetify3
- Language: JavaScript
- Homepage: https://about-me-jacksonsantin.vercel.app/
- Size: 5.67 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
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](https://git-scm.com), [Node.js](https://nodejs.org/en/) + NPM.
Além disto é importante ter um bom editor para trabalhar com o código, sugiro o [VSCode](https://code.visualstudio.com/)
Você também pode utilizar uma ferramenta para poder consumir a API backend, para esse projeto, utilizamos o [Insomnia](https://insomnia.rest/).
#### 🎲 Rodando o Backend (servidor)
```bash
# 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)
```bash
# 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](https://vuejs.org/)) + [Vuetify](https://vuetifyjs.com/en/))
- **[Axios](https://github.com/axios/axios)**
> Veja o arquivo [package.json](https://github.com/JacksonSantin/api-web-person/blob/main/web/package.json)
#### **Backend** ([NodeJS](https://nodejs.org/en/) + [Javascript](https://www.javascript.com/))
- **[Express](https://expressjs.com/)**
- **[CORS](https://expressjs.com/en/resources/middleware/cors.html)**
- **[MongoDB](https://www.mongodb.com/atlas/database)**
- **[SwaggerUI](https://swagger.io/tools/swagger-ui/)**
- **[mongoose](https://mongoosejs.com/)**
- **[nodemon](https://nodemon.io/)**
- **[dotenv](https://www.dotenv.org/)**
> Veja o arquivo [package.json](https://github.com/JacksonSantin/api-web-person/blob/main/server/package.json)
#### **Utilitários**
- Editor: **[Visual Studio Code](https://code.visualstudio.com/)**
---
## 👨💻 Contribuidores
## 💪 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
---
## 📝 Licença
Este projeto esta sobe a licença [MIT](https://github.com/JacksonSantin/api-web-person/blob/master/LICENSE).
Feito com ❤️ por Jackson Dhanyel Santin 👋🏽 [Entre em contato!](https://curriculum-vitae-jacksonsantin.vercel.app/contato)
---
