Code Monkey home page Code Monkey logo

tasks-api-with-doc's Introduction

Tasks-api-with-doc

Tasks-api-with-doc is a laravel powered api of tasks gestion. Using token for connextion. This project is made mainly for learning how to use and make feature&unit test.

โ†’hosted version(Is on heroku so might take some time to load at first)

โ†’documentation with swagger

Quick Start

# Install Dependencies
composer install

# Run Migrations
php artisan migrate

# MAke a copy of your .env file
cp .env.example .env

## Create your db and like it to your project via the .env

# If you get an error about an encryption key
php artisan key:generate

Current test

# run the tests
php artisan test

Global

  • 404 not found

User

  • register

    • everything is well filled

    • email empty

    • email wrong format

    • email already taken

    • email is not a string

    • password empty

    • password wrong format

    • password too short

    • password is not a string

    • username empty

    • username is not a string

  • login

    • everything is well filled

    • email empty

    • email wrong format

    • email do not match the records

    • email is not a string

    • password empty

    • password wrong format

    • password too short

    • password do not match the record

    • password is not a string

Tasks

  • create
    • everything is well filled

    • body empty

    • body is not a string

    • token empty or expired

  • read
    • one of the user's task
      • everything is well filled
      • no user's task has the given id
      • token empty or expired
    • all of the user's task
      • everything is well filled
      • only the completed tasks
      • only the non-completed tasks
      • token empty or expired
  • update
    • everything is well filled

    • no user's task has the given id

    • completed empty

    • completed is not a boolean

    • token empty or expired

  • delete
    • everything is well filled
    • no user's task has the given id
    • token empty or expired

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT

tasks-api-with-doc's People

Contributors

arielt99 avatar

Watchers

 avatar  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.