Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/igorsimoes4/jornadamilhas
A API Jornada Milhas é uma aplicação web que fornece pontos de acesso para gerenciar depoimentos de clientes. A API permite que os usuários leiam depoimentos existentes e enviem os seus próprios. Foi desenvolvida usando o framework Laravel.
https://github.com/igorsimoes4/jornadamilhas
alurachallengeback blade laravel9 php8 vitrinedev
Last synced: about 2 months ago
JSON representation
A API Jornada Milhas é uma aplicação web que fornece pontos de acesso para gerenciar depoimentos de clientes. A API permite que os usuários leiam depoimentos existentes e enviem os seus próprios. Foi desenvolvida usando o framework Laravel.
- Host: GitHub
- URL: https://github.com/igorsimoes4/jornadamilhas
- Owner: igorsimoes4
- Created: 2023-07-11T01:04:49.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2023-08-26T01:32:21.000Z (over 1 year ago)
- Last Synced: 2024-10-12T11:23:15.107Z (3 months ago)
- Topics: alurachallengeback, blade, laravel9, php8, vitrinedev
- Language: PHP
- Homepage:
- Size: 18.6 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# API Jornada Milhas
A API Jornada Milhas é uma aplicação web que fornece endpoints para gerenciar depoimentos de clientes. A API permite que os usuários leiam depoimentos existentes e enviem seus próprios depoimentos. Foi desenvolvida utilizando o framework Laravel.
| :placard: Vitrine.Dev | https://cursos.alura.com.br/vitrinedev/igor01silveira |
| ------------- | --- |
| :sparkles: Nome | **Api Jornada Milhas**
| :label: Tecnologias | php, laravel
| :fire: Desafio | [Link do Desafio](https://www.alura.com.br/challenges/back-end-7/semana-01-classes-relacionamentos-depoimentos)
## Detalhes do projeto
✔️ Técnicas e tecnologias utilizadas
- ``Laravel``
- ``PHP``
- ``MySQL``
- ``Visual Studio Code``
- ``Orientação a Objetos``
- ``PHPUnit``
## Rotas Depoimentos
### Obter Depoimentos Aleatórios
Recupera até 3 depoimentos aleatórios para exibir na página inicial.
- **URL:** `/api/depoimentos-home`
- **Método:** `GET`
- **Resposta de Sucesso:**
- **Código de Status:** 200 OK
- **Conteúdo:** Array JSON contendo até 3 depoimentos, cada um com as seguintes propriedades:
- `id` (integer): O identificador único do depoimento.
- `depoimento` (string): O conteúdo do depoimento.
- `user_name` (string): O nome do usuário que enviou o depoimento.
- `foto` (string): A URL da foto do usuário (opcional).
- **Resposta de Erro:**
- **Código de Status:** 404 Not Found
- **Conteúdo:** Objeto JSON com a seguinte propriedade:
- `message` (string): "Nenhum depoimento encontrado!" (Nenhum depoimento encontrado).
### Enviar Depoimento
Permite que os usuários enviem seus próprios depoimentos.
- **URL:** `/api/depoimentos/create`
- **Método:** `POST`
- **Parâmetros de Dados:** Objeto JSON contendo as seguintes propriedades:
- `depoimento` (string, obrigatório): O conteúdo do depoimento.
- `nome_user` (string, obrigatório): O nome do usuário que está enviando o depoimento.
- **Resposta de Sucesso:**
- **Código de Status:** 201 Created
- **Conteúdo:** Objeto JSON representando o depoimento criado, com as seguintes propriedades:
- `id` (integer): O identificador único do depoimento.
- `depoimento` (string): O conteúdo do depoimento.
- `user_name` (string): O nome do usuário que enviou o depoimento.
- `foto` (string): A URL da foto do usuário (opcional).
### Atualizar Depoimento
Permite atualizar um depoimento existente.
- **URL:** `/api/depoimentos/{id}`
- **Método:** `PUT`
- **Parâmetros da URL:** `id` (integer, obrigatório): O identificador único do depoimento a ser atualizado.
- **Parâmetros de Dados:** Objeto JSON contendo os campos a serem atualizados:
- `depoimento` (string, opcional): O conteúdo atualizado do depoimento.
- `nome_user` (string, opcional): O nome atualizado do usuário que enviou o depoimento.
- **Resposta de Sucesso:**
- **Código de Status:** 200 OK
- **Conteúdo:** Objeto JSON representando o depoimento atualizado, com as seguintes propriedades:
- `id` (integer): O identificador único do depoimento.
- `depoimento` (string): O conteúdo atualizado do depoimento.
- `user_name` (string): O nome atualizado do usuário que enviou o depoimento.
- `foto` (string): A URL da foto do usuário (opcional).
### Excluir Depoimento
Permite excluir um depoimento existente.
- **URL:** `/api/depoimentos/{id}`
- **Método:** `DELETE`
- **Parâmetros da URL:** `id` (integer, obrigatório): O identificador único do depoimento a ser excluído.
- **Resposta de Sucesso:**
- **Código de Status:** 200 OK
- **Conteúdo:** Objeto JSON com a seguinte propriedade:
- `message` (string): "Depoimento excluído com sucesso!" (Depoimento excluído com sucesso).
## Códigos de Status
- 200 OK: A requisição foi bem-sucedida.
- 201 Created: O recurso foi criado com sucesso.
- 404 Not Found: O recurso solicitado não foi encontrado.
Por favor, observe que esta API não implementa autenticação de usuários ou outras medidas de segurança. Versões futuras podem incluir esses recursos para garantir a integridade dos dados e a privacidade dos usuários.
# 📁 Acesso ao projeto
Você pode acessar o código fonte completo do projeto [aqui](https://github.com/igorsimoes4/jornada-milhas).
# 🛠️ Abrir e rodar o projeto
Para abrir e executar o projeto, siga as instruções abaixo:
## Pré-requisitos
Antes de prosseguir, certifique-se de ter as seguintes tecnologias instaladas em seu ambiente de desenvolvimento:
- [PHP 7.4](https://www.php.net/)
- [Composer](https://getcomposer.org/)
- [MySQL 8.0](https://www.mysql.com/)
- [Visual Studio Code](https://code.visualstudio.com/) (ou IDE de sua preferência)
## Passo 1: Clonar o repositório
Clone o repositório do projeto para o seu ambiente local usando o seguinte comando Git:
```bash
git clone https://github.com/igorsimoes4/jornada-milhas.git
```
## Passo 2: Instalar as dependências
Navegue até o diretório do projeto e instale as dependências do Composer executando:
```bash
cd jornada-milhas
composer install
```
## Passo 3: Configurar o ambiente
Faça uma cópia do arquivo `.env.example` e renomeie-o para `.env`. Em seguida, atualize as configurações do banco de dados no arquivo `.env` com suas credenciais locais:
```bash
DB_CONNECTION=mysql
DB_HOST=seu-host
DB_PORT=seu-port
DB_DATABASE=seu-database
DB_USERNAME=seu-usuario
DB_PASSWORD=sua-senha
```
## Passo 4: Executar as migrações
Com o ambiente configurado, crie as tabelas necessárias no banco de dados executando as migrações:
```bash
php artisan migrate
```
## Passo 5: Executar o servidor
Finalmente, inicie o servidor de desenvolvimento local com o comando:
```bash
php artisan serve
```
O projeto estará disponível em `http://localhost:8000`.
Agora você pode acessar e testar a API Jornada Milhas localmente.
# Autor
[
Igor Simões da Silveira](https://github.com/igorsimoes4)