Website/items/api/README.md
SPT-dev 1153ac24bf feat: Add items website code base + drone pipeline (#9)
Hello,

I'm adding the whole https://items.sp-tarkov.com code base as well as the drone pipeline to deploy it.
Please **double check *thoroughly* every** to ensure it matches the server architecture and configuration.
2023-03-02 21:35:55 -05:00

14 lines
652 B
Markdown

# SP Tarkov items API
## How to install
* Clone the repo
* Make sure you have PHP and composer installed on your PC
* To verify that you have PHP and composer working, try these commands `php -v` and `composer -v`
* Go inside the cloned repo and install the dependencies with this command `composer install`
* If you don't have a local server like Apache or Nginx, you can use PHP to start a server with this command in the root folder of the repo `php -S localhost:8000 -t public`
## How to use
* Check the `routes/web.php` for the available routes and use whatever utility you are confortable with to call the API endpoints, ex: Postman