Skip to content

abrahamuchos/inventory-api

Repository files navigation

Inventory API

This is an experimental API to manage inventory and stock. All this by managing your users (they must log in).

Rest API for managing items, repurchase, users and stock.

✅ Features

  • Add item
  • Update item
  • Get items by filters
  • Get item (by sku)
  • Get stock and reorder status
  • Add stock
  • Reduce stock
  • Register user
  • Login user

⚙️ Tech Stack

  • Laravel 11.9
  • SqLite
  • Pest 2.0

💾 Installation

Install and run

  1. Clone and move to folder
$ git clone git@github.com:abrahamuchos/inventory-api.git
$ cd inventory-api
  1. Install dependecies
$  composer install
  1. Create a copy of the .env.example file and rename it to .env. Next, configure the necessary environment variables.

  2. Generate an application key by running php artisan key:generate.

  3. Run php artisan migrate to create the database tables.

  4. Run php artisandb:seed to create dummy data and admin user.

  5. Run php artisan serve to start the Laravel development server.

🧪 Tests

To run all the tests

 $ php artisan test

To run a specific test

 $ php artisan test --filter test_name_example

📄 Docs

Invoice API Collection - Postman

Invoice API Collection - Postman

You can find a .json with the endpoints in /docs/Inventory API.postman_collection.json

🧑‍💻 Authors

📄 License

MIT

About

API inventory system developed in Laravel under the TDD methodology.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages