Code Monkey home page Code Monkey logo

tododev's Introduction

TodoDev - A sua lista de tarefas

Demonstração

Tecnologias utilizadas

  • PHP
  • Laravel
  • MySQL
  • HTML5
  • CSS3
  • SASS
  • Bootstrap
  • Javascript
  • Jquery
  • Axios
  • API REST
  • PHPUnit

Pré-requisitos

Antes de começar, você vai precisar ter instalado em sua máquina as seguintes ferramentas: Git, PHP (>= 7.0.0), Composer e MySQL.

Rodando o Projeto

Clone o repositório

git clone https://github.com/Claytonrss/TodoDev.git

Acesse a pasta do repositório

cd TodoDev

Instale todas as dependências utilizando os comandos

composer install
npm install
npm run dev

Definindo um banco de dados

Utilizando o MySQL, crie um banco de dados com o nome tododev

Renomeie o arquivo .env_exemple para .env

cp .env_exemple .env

Preencha o arquivo .env com as informações do servidor onde está criado o banco de dados

DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=tododev
DB_USERNAME=root
DB_PASSWORD=

Execute o comando abaixo para criação e configuração das tabelas dentro do banco de dados

php artisan migrate

Inicie o servidor de local

php artisan serve

Agora você pode acessar o servidor em http://localhost:8000

Especificação da API

Utilizando os passos anteriores, é possível também acessar a API construída com Laravel em http://localhost:8000/api/

Endpoints:

Listar tarefas

GET /api/todos

Exemplo do corpo da resposta:

{ {
  "type": "success",
  "todos": [
    {
      "id": 2,
      "description": "Criar Layout",
      "status": 0,
      "created_at": "2021-07-04T20:33:04.000000Z",
      "updated_at": "2021-07-04T20:33:04.000000Z"
    },
    {
      "id": 1,
      "description": "Finalizar API",
      "status": 0,
      "created_at": "2021-07-04T20:32:50.000000Z",
      "updated_at": "2021-07-04T20:32:50.000000Z"
    }
  ]
} }

Criar tarefa

POST /api/todos

Exemplo do corpo da requisição:

{
	"description" : "",
	"status": 0
}

Exemplo do corpo da resposta:

{
  "type": "success",
  "todo": {
    "id": 1,
    "description": "Finalizar API",
    "status": 0,
    "created_at": "2021-07-04T20:32:50.000000Z",
    "updated_at": "2021-07-04T20:38:35.000000Z"
  }
}

Atualizar tarefa

PUT /api/todos/id

Exemplo do corpo da requisição:

{
	"status": 1
}

Exemplo do corpo da resposta:

{
  "type": "success",
  "todo": {
    "id": 1,
    "description": "Finalizar API",
    "status": 1,
    "created_at": "2021-07-04T20:32:50.000000Z",
    "updated_at": "2021-07-04T20:38:35.000000Z"
  }
}

Deletar tarefa

DELETE /api/todos/id

Exemplo do corpo da resposta:

{
  "type": "success"
}

Rodando os Testes

Foi utilizado o PHPUnit para escrever os testes unitários. Para rodar os testes, execute o seguinte comando:

  ./vendor/bin/phpunit

Autor


Feito com ❤️ por Clayton Rafael 👋🏽 Entre em contato!

Gmail Badge Linkedin Badge Linkedin Badge

📝 Licença

Este projeto esta sobe a licença MIT.

tododev's People

Contributors

claytonrss avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.