ZeyadTarekk/Products-Warehouse

📝 Table of Contents

• About
• API Endpoint
• Get started
  • Installation
  • Running
• Technology
• Contributors
• License

📙 About

• A Product warehouse api.

🔚 API Endpoints

Customers

• GET /customer/:customerId
• GET /customer
• POST /customer
• DELETE /customer/:customerId
• PUT /customer/:customerId

Products

• GET /product/:productId
• GET /product
• POST /product
• DELETE /product/:productId
• PUT /product/:productId

Products

• GET /warehouse/:warehouseId
• GET /warehouse
• POST /warehouse
• DELETE /warehouse/:warehouseId
• PUT /warehouse/:warehouseId

🏁 Getting Started

This is an list of needed instructions to set up your project locally, to get a local copy up and running follow these instructuins.

Installation

1. Clone the repository

$ git clone https://github.com/ZeyadTarekk/Products-Warehouse.git

2. Navigate to repository directory

$ cd Products-Warehouse

3. Install dependencies

npm install

Running

1. Running migrations up

npm run migrateup

2. Running on development mode

npm run dev

1. Running migrations down

npm run migratedown

💻 Built Using

• Node.js
• Express.js
• Multer
• db-migrate

Contributors

Zeyad Tarek

License

This software is licensed under MIT License, See License for more information ©ZeyadTarekk.