thaimedeiros / apirest-laravel

API Restfull using framework Laravel

Teste de backend para a Beta Sistemas

• Um pequeno exemplo de API Restfull utilizando framework Laravel,
  • Observação: com autenticação do Passport.

📰 Features  |   📌 Pré-requisitos  |   💻 Tecnologias  |   ▶️ Rodando o Projeto  |   🧩 Como Contribuir  |   📝 Licença

📰 Features

• Realiza login com o passport.
• CRUD de categorias:
  • Cria;
  • Lê;
  • Atualiza;
  • Exclui.
• CRUD de produtos:
  • Cria;
  • Lê;
  • Atualiza;
  • Exclui.

📌 Pré-requisitos

Observação: o Laragon e o Xampp já contém um servidor Apache e um MySQL. Com isso, não é necessário instalar separadamente o Apache e o MySQL.

• Apache
• Composer
• Git
• Laragon ou XAMPP
• Laravel
• MySQL
• Postman
• VSCode

💻 Tecnologias

• Esse projeto foi desenvolvido com as seguintes tecnologias:
  • Composer;
  • MySQL;
  • Laravel;
    • Passport;
  • PHP.

▶️ Rodando o Projeto

Siga os seguintes passos para instalar:

# clonando o projeto na sua maquina
$ git clone https://github.com/ThaiMedeiros/apirest-laravel.git

# entre na pasta do projeto
$ cd apirest-laravel

# logo depois entre na pasta da API
$ cd api

# 1. copie o arquivo: >> .env.example << cole no mesmo diretório em que se encontra
# 2. remova a extensão >> .example <<
# 3. Então, coloque as credenciais de acesso ao seu banco de dados, no agora arquivo >> .env <<

# inicialize os servidores Apache e MySQL
$ execute o **laragon** ou **xampp** (ou outro servidor web)

# logo após a inicialização, acesse no browser:
$ http://localhost://phpmyadmin (então crie um novo banco de dados)
# Observação: o nome do banco de dados deve ser o mesmo que consta no arquivo .env

# agora, entre na pasta >> api << e para instalar as dependências do projeto, execute:
$ `composer install` ou `composer update` (e aguarde o término)

# para gerar uma chave >> APP_KEY= << criptografada,
# que pode ser usada posteriormente em autenticações se necessário, execute:
$ `php artisan key:generate`

# para rodar as migrações/tabelas no banco de dados
$ `php artisan migrate`

# gerar duas chaves criptografadas no banco para realizar as autenticações
$ `php artisan passport:install`

# Observação: sempre que apagar todas as tabelas do banco de dados,
# rode o >> passport:install << novamente após o >> migrate <<

# caso queria popular o banco de dados para começar as suas requisições, execute:
$ `php artisan db:seed`

# para inicializar, execute no terminal o comando:
$ `php artisan serve`

# poderá acessá-lo através do endereço:
$ `http://localhost:8000`

• Depois de inicializado, já é possível começar os testes! Então, clique: API

🧩 Como Contribuir

1. Faça um fork desse projeto.
2. Crie uma nova branch para trabalhar: git checkout -b my-feature
3. Faça commit da sua feature: git commit -m "feature: My new feature"
4. Envie as suas alterações: git push origin my-feature
5. Solicite uma Pull Request para o diretório original.

📝 Licença

Esse projeto está sob a licença ⚖️ MIT License. Veja o arquivo LICENSE para mais detalhes.

---

Desenvolvido por: ©️ Thaiza Medeiros 👩‍💻 💜