Build a 3D Inventory API with Node.js & MongoDB: A Step-by-Step Guide

Build a 3D inventory API with the MEAN stack. This guide uses Node.js & MongoDB to create a backend for spatial inventory management.

Build a 3D inventory API with the MEAN stack. This guide uses Node.js & MongoDB to create a backend for spatial inventory management.

3d-inventory-mongo-api

  1. 3d-inventory-mongo-api
    1. Purposes
    2. Architecture
    3. Features
      1. MEAN stack
    4. Data Model
    5. API documentation
    6. Getting Started
    7. License

wakatimeGitHub latest commitGitHub issuesmade-with-javascriptNpm package versionGitHub licenseGitHub stars

About

Backend API for the 3D-Inventory platform — a modern inventory management system that combines spatial visualization with structured inventory data. This Node.js-based API uses MongoDB as its primary database and serves inventory data to a frontend interface built in ✨3d-inventory✨.

🌟 Features

🗃️ RESTful API for managing inventory elements, racks, rooms, and objects
🌍 MongoDB schema designed for spatial and visual representation of inventory items
🧩 Modular structure using Express.js
🔐 Secure API endpoints with basic validation
🔄 Designed to support 3D spatial UI representation in real-time

MEAN stack

  • MongoDB is a NoSQL database that stores data in JSON format.
  • Express.js is a web application framework for Node.js that simplifies the process of building web servers and APIs.
  • RxJs – Reactive Extensions Library for JavaScript.
  • NodeJS is a JavaScript runtime that allows you to run code on the server-side.

📚 API Endpoints

Swagger API definition.

Endpoint Method Description
/devices GET Get all devices
/devices POST Create a new device
/devices/ GET Get device by ID
/devices/ PUT Update device by ID
/devices/ DELETE Delete device by ID
/models GET Get all models
/models POST Create a new model
/models/ GET Get model by ID
/models/ PUT Update model by ID
/models/ DELETE Delete model by ID
/connections GET Get all connections
/connections POST Create a new connection
/connections/ GET Get connection by ID
/connections/ PUT Update connection by ID
/connections/ DELETE Delete connection by ID
/logs GET Get all logs
/logs/ GET Get log by ID
/attributes GET Get all attributes
/attributes POST Create a new attribute
/attributes/ GET Get attribute by ID
/attributes/ PUT Update attribute by ID
/attributes/ DELETE Delete attribute by ID
/attributesDictionary GET Get all attribute dictionary entries
/attributesDictionary POST Create a new attribute dictionary entry
/attributesDictionary/ GET Get attribute dictionary entry by ID
/attributesDictionary/ PUT Update attribute dictionary entry by ID
/attributesDictionary/ DELETE Delete attribute dictionary entry by ID
/floors GET Get all floors
/floors POST Create a new floor
/floors/ GET Get floor by ID
/floors/ PUT Update floor by ID
/floors/ DELETE Delete floor by ID

Getting Started

To get started with the 3D Inventory Mongo API, follow the instructions below:

git clone https://github.com/karol-preiskorn/3d-inventory-mongo-api.git
cd 3d-inventory-mongo-api
npm install
npm start

License

This project is licensed under the Creative Commons Legal Code.

October 29th, 20233d-inventory, linux, mongo, portfoilio, recent 0 comments on Build a 3D Inventory API with Node.js & MongoDB: A Step-by-Step Guide413, ,

Building a 3D Datacenter Inventory with Angular and Three.js

3d-inventory / docker / js / mongo / portfoilio / recent

brown teapot on stick link table runner

The Art of Zisha: A Complete Guide to Handmade Yixing Teapots

portfoilio / pottery

How to youtube-dl

linux

person in black and white t-shirt using computer

Projektowanie stron i sklepów WordPress

portfoilio / wordpress

Subscribe
Notify of
guest
0 Comments
Newest
Oldest Most Voted
Inline Feedbacks
View all comments