mirror/Part-DB.Part-DB-server
1
0
Fork 1
mirror of https://github.com/Part-DB/Part-DB-server.git synced 2025-06-20 17:15:51 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions
Part-DB.Part-DB-server/README.md
Jan Böhmer 7e8752d1a2 Added coverage badge to Github README page.
2019-10-20 20:05:11 +02:00

4.7 KiB
Raw Blame History

Scrutinizer Code Quality Build Status codecov GitHub License PHP Version

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!!

Demo

If you want to test Part-DB without installing it, you can use this Heroku instance. (Or this link for the German Version).

You can log in with username: user and password: user.

Every change to the master branch gets automatically deployed, so it represents the currenct development progress and is maybe not completly stable. Please mind, that the free Heroku instance is used, so it can take some time when loading the page for the first time.

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

Caution: It is possible to upgrade the old Part-DB databases. Anyhow, the migrations that will be made, are not compatible with the old Part-DB versions, so you must not use the old Part-DB versions with the new database, or the DB could become corrupted. Also after the migration it is not possible to go back to the old database scheme, so make sure to make a backup of your database beforehand.

  1. Copy or clone this repository into a folder on your server.
  2. Configure your webserver to serve from the public/ folder. See here for additional informations.
  3. Copy the global config file cp .env .env.local and edit .env.local:
    • Change the line APP_ENV=dev to APP_ENV=prod
    • Change the value of DATABASE_URL= to your needs (see here) for the format.
  4. Install composer dependencies and generate autoload files: composer install --no-dev
  5. Install client side dependencies and build it: yarn install and yarn build
  6. Optional (speeds up first load): Warmup cache: php bin/console cache:warmup
  7. Upgrade database to new scheme (or create it, when it was empty): php bin/console doctrine:migrations:migrate and follow the instructions given. Caution: This steps tamper with your database and could potentially destroy it. So make sure to make a backup of your database.
  8. (If you update from an older Part-DB Version (< 1.0) run php bin/console app:convert-bbcode to convert the BBCode used in comments and part description to the newly used markdown.)

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

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.