/motostock-api

Primary LanguagePHP

Motostock API

REST API of Vehicle Warehouse System

Issues MIT License

Table of Contents
  1. About The Project
  2. Getting Started
  3. Features
  4. License
  5. Contact

About The Project

Since it's not defined, we're don't know why this project created.

Getting Started

Prerequisites

When you're going to contribute or compile, you'll need at least:

  • PHP 8.x
  • MongoDB 4.1

Installation or Configure

# clone if you don't have the code base
$ git clone git@github.com:thisham/motostock-api.git

# install dependencies
$ composer install

# run development server
$ php artisan server

Deployment Guide

  1. Clone the project and install project production dependencies

    # clone if you don't have the code base
$ git clone git@github.com:thisham/motostock-api.git

# install production dependencies
$ composer install --production

  2. Move to php server (such as nginx, apache etc.) then address it at public/ directory.

API Specification

Access at route /docs while app running.

Feature

  • Transaction Management
  • Stock Viewer
  • Selling Report

License

The unlicensed one.

Contact