partkeepr

fork of partkeepr
git clone https://git.e1e0.net/partkeepr.git
Log | Files | Refs | Submodules | README | LICENSE

README.md (2011B)


      1 [![PartKeepr](https://partkeepr.org/images/partkeepr-banner.png)](https://www.partkeepr.org)
      2 
      3 [![JSON-LD enabled](http://json-ld.org/images/json-ld-button-88.png)](http://json-ld.org)
      4 [![Build Status](https://travis-ci.org/partkeepr/PartKeepr.svg?branch=sf2migration)](https://travis-ci.org/partkeepr/PartKeepr)
      5 [![SensioLabsInsight](https://insight.sensiolabs.com/projects/a9f5bdce-ac86-4c51-b87d-56fd0f241155/mini.png)](https://insight.sensiolabs.com/projects/a9f5bdce-ac86-4c51-b87d-56fd0f241155)
      6 [![Code Climate](https://codeclimate.com/github/partkeepr/PartKeepr/badges/gpa.svg)](https://codeclimate.com/github/partkeepr/PartKeepr)
      7 [![Test Coverage](https://codeclimate.com/github/partkeepr/PartKeepr/badges/coverage.svg)](https://codeclimate.com/github/partkeepr/PartKeepr/coverage)
      8 [![codecov](https://codecov.io/gh/partkeepr/PartKeepr/branch/master/graph/badge.svg)](https://codecov.io/gh/partkeepr/PartKeepr)
      9 
     10 
     11 PartKeepr is an [inventory management software](https://en.wikipedia.org/wiki/Inventory_management_software), primarily
     12 designed for electronic components.
     13 
     14 PartKeepr is written in **PHP** and using the [**Symfony2**](http://symfony.com) framework.
     15 
     16 Demo Sites
     17 ----------
     18 
     19 To test everything which has been written so far, there are two demo pages prepared.
     20 
     21 The latest release from github is available at http://demo.partkeepr.org.
     22 The most up-to-date version of the GitHub `master` branch is published at https://demo-git.partkeepr.org.
     23 Both demo pages are built from the git sources and reset to a demo state once an hour.
     24 
     25 Requirements
     26 ------------
     27 
     28 PartKeepr needs:
     29 
     30 * PHP between 7.0 and 7.1 - migration to newer symfony is needed before we support current php 7.x
     31 * A MySQL or PostgreSQL database
     32 
     33 Installation
     34 ------------
     35 
     36 Please read our [setup guide](documentation/Installation.md)
     37 
     38 Thanks
     39 ------
     40 
     41 A very big "thank you" goes out to Georgyo of NYC resistor - although he claimed that he isn't creative, he invented the
     42 name "PartKeepr" which eventually became the project's name.