Code Monkey home page Code Monkey logo

corrugation-backend's Introduction

Corrugation

Current State

Corrugation is rough around the edges, barely serving my own needs as is. It may be built as a minimal (15MB) docker image for simple deployment.

If you happen to use docker-compose on a VPS, then the push.sh script may be helpful for rapid development. Modify the script to point to your docker-conmpose.yaml, then do something like ./push.sh [email protected]

Known issues

Authentication

Authentication is currently broken I believe

Frontend does not persist current location

This is being worked on

Design

The API shall adhere to KISS - it is highly opinionated, and intentionally dumb, so as to make it easier to work on. I will expand it only when core functionality is complete.

What Corrugation is NOT

Corrugation is NOT a replacement to Inventree or any other parts inventory system. It is targeted towards household items, those which need not have prices added or even require quantities specified, nor specific part numbers. For example, I don't want to have to say how many pencils, and which brand - only that a drawer contains pencils.

Key concepts

Entity

The core unit, may describe a location or item. It may have a name, description, a number of artifacts, and a location.

Artifact

Artifacts may be uploaded and referenced by any entity. This is intended to allow linking images for any given location or item, to allow easier visualization of contents or location. It may also allow linking documents such as user manual scans to items.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.