.github | ||
assets | ||
bin | ||
config | ||
public | ||
src | ||
templates | ||
tests | ||
translations | ||
.env | ||
.env.test | ||
.gitignore | ||
.travis.yml | ||
.yarnclean | ||
CODE_OF_CONDUCT.md | ||
composer.json | ||
composer.lock | ||
LICENSE.md | ||
package.json | ||
phpunit.xml.dist | ||
Procfile | ||
README.md | ||
symfony.lock | ||
VERSION | ||
webpack.config.js | ||
yarn.lock |
Part-DB
Part-DB is an Open-Source inventory managment system for your electronic components. It is installed on a web server and so can be accessed with any browser without the need to install additional software.
The version in this Repository is a complete rewrite of the legacy Part-DB (Version < 1.0) based on a modern framework. In the moment it lacks many features from the old Part-DB and the testing and documentation is not finished, so this version is not recommendend for productive work!!
Features
- TODO
Requirements
- A web server (like Apache2 or nginx) that is capable of running Symfony 4, this includes a minimum PHP version of PHP 7.1.3
- A MySQL/MariaDB database server
- Shell access to your server is highly suggested!
- For building the client side assets yarn and nodejs is needed.
Installation
- Copy or clone this repository into a folder on your server.
- Configure your webserver to serve from the
public/
folder. See here for additional informations. - Copy the global config file
cp .env .env.local
and edit.env.local
:- Change the line
APP_ENV=dev
toAPP_ENV=prod
- Change the value of
DATABASE_URL=
to your needs (see here) for the format. Currently it is not possible to create a new databse. You have to use the database created by an old Part-DB version!
- Change the line
- Install composer dependencies and generate autoload files:
composer install --no-dev
- Install client side dependencies and build it:
yarn install
andyarn build
- Install CKEditor:
php bin/console ckeditor:install
- Optional (speeds up first load): Warmup cache:
php bin/console cache:warmup
When you want to upgrade to a newer version, then just copy the new files into the folder and repeat the steps 4. to 7.
Built with
- Symfony 4: The main framework used for the serverside PHP
- Bootstrap 4 and Fontawesome : Used for the webpages
Authors
- Jan Böhmer - Inital work - Github
See also the list of contributors who participated in this project.
Based on the original Part-DB by Christoph Lechner and K. Jacobs
License
Part-DB is licensed under the General Public License 2 (or at your opinion any later). This mostly means that you can use Part-DB for whatever you want (even use it commercially) as long as you publish the source code for every change you make under the GPL, too.
See License.md for more informations.