mirror/Part-DB.Part-DB-server
1
0
Fork 1
mirror of https://github.com/Part-DB/Part-DB-server.git synced 2025-06-21 01:25:55 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Updated README.md and UPGRADE.md

Browse source 
Also closes pull request #47.
This commit is contained in:
Jan Böhmer 2020-05-12 23:42:03 +02:00
parent e836a9d036
commit b6e719893a
2 changed files with 23 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

24
README.md
View file

@ -12,8 +12,10 @@ Part-DB is an Open-Source inventory managment system for your electronic compone
It is installed on a web server and so can be accessed with any browser without the need to install additional software. 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](https://github.com/Part-DB/Part-DB) (Version < 1.0) based on a modern framework. The version in this Repository is a complete rewrite of the legacy [Part-DB](https://github.com/Part-DB/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 In the moment it lacks some features from the old Part-DB and the testing and documentation is not finished.
this version is not recommendend for productive work!! Part-DB is in undergoing development, that means features and appeareance can change, and the software can contain bugs.
If you find a bug, please open an [Issue on Github](https://github.com/Part-DB/Part-DB-symfony/issues) so it can be fixed for everybody.
## Demo ## Demo
If you want to test Part-DB without installing it, you can use [this](https://part-db.herokuapp.com) Heroku instance. If you want to test Part-DB without installing it, you can use [this](https://part-db.herokuapp.com) Heroku instance.
@ -32,14 +34,14 @@ list of the features could change in the future. Features that are not working y
* Inventory managment of your electronic parts. Each part can be assigned to a category, footprint, manufacturer * Inventory managment of your electronic parts. Each part can be assigned to a category, footprint, manufacturer
and multiple store locations and price informations. Parts can be grouped using tags. Support for file attachments like datasheets. and multiple store locations and price informations. Parts can be grouped using tags. Support for file attachments like datasheets.
* Multi-Language support (currently German, English, Russian, Japanese and French (experimental)) * Multi-Language support (currently German, English, Russian, Japanese and French (experimental))
* Barcodes/Labels generator for parts and storage locations (*) * Barcodes/Labels generator for parts and storage locations
* User system with groups and detailed permissions. * User system with groups and detailed permissions.
Two-factor authentication is supported (Google Authenticator and U2F keys) and can be enforced. Password reset via email can be setuped. Two-factor authentication is supported (Google Authenticator and U2F keys) and can be enforced. Password reset via email can be setuped.
* Import/Export system (*) * Import/Export system (*)
* Project managment: Parts can be assigned to projects to manage how often a project can be build. (*) * Project managment: Parts can be assigned to projects to manage how often a project can be build. (*)
* Order managment: Collect parts that should be ordered during the next order on your distributor and automatically add * Order managment: Collect parts that should be ordered during the next order on your distributor and automatically add
it to your instock, when they arrive. (*) it to your instock, when they arrive. (*)
* Event log: Track what changes happens to your inventory, track which user does what. (*) * Event log: Track what changes happens to your inventory, track which user does what. Revert your parts to older versions.
* Responsive design: You can use Part-DB on your PC, your tablet and your smartphone using the same interface. * Responsive design: You can use Part-DB on your PC, your tablet and your smartphone using the same interface.
* PartKeepr import (*) * PartKeepr import (*)
@ -76,10 +78,24 @@ for additional informations.
6. Install client side dependencies and build it: `yarn install` and `yarn build` 6. Install client side dependencies and build it: `yarn install` and `yarn build`
7. _Optional_ (speeds up first load): Warmup cache: `php bin/console cache:warmup` 7. _Optional_ (speeds up first load): Warmup cache: `php bin/console cache:warmup`
8. 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. 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.
9. You can configure Part-DB via `config/parameters.yaml`. You should check if settings match your expectations, after you installed/upgraded Part-DB. Check if `partdb.default_currency` matches your mainly used currency (this can not be changed after creating price informations).
Run `php bin/console cache:clear` when you changed something.
When you want to upgrade to a newer version, then just copy the new files into the folder 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. and repeat the steps 4. to 7.
## Useful console commands
Part-DB provides some command consoles which can be invoked by `php bin/console [command]`. You can get help for every command with the parameter `--help`.
Useful commands are:
* `php bin/console app:set-password [username]`: Sets a new password for the user with the given username. Useful if you forget the password to your Part-DB instance.
* `php bin/console app:show-logs`: Show last activty log on console. Use `-x` options, to include extra column.
* `php bin/console app:update-exchange-rates`: Update the exchange rates of your currencies from internet. Setup this to be run in a cronjob to always get up-to-date exchange rates.
If you dont use Euro as base currency, you have to setup an fixer.io API key in `.env.local`.
* `php bin/console app:clean-attachments`: Removes all unused files (files without an associated attachment) in attachments folder.
Normally Part-DB should be able to delete the attachment file, if you delete the attachment, but if you have some obsolete files left over from legacy Part-DB you can remove them safely with this command.
* `php cache:clear`: Remove and rebuild all caches. If you encounter some weird issues in Part-DB, it maybe helps to run this command.
* `php .\bin\console doctrine:migrations:up-to-date`: Check if your database is up to date.
## Built with ## Built with
* [Symfony 4](https://symfony.com/): The main framework used for the serverside PHP * [Symfony 4](https://symfony.com/): The main framework used for the serverside PHP
* [Bootstrap 4](https://getbootstrap.com/) and [Fontawesome](https://fontawesome.com/) : Used for the webpages * [Bootstrap 4](https://getbootstrap.com/) and [Fontawesome](https://fontawesome.com/) : Used for the webpages

4
UPGRADE.md
View file

@ -7,7 +7,7 @@ The instructions on how to install the new version or upgrade from Part-DB 1.0 t
## Breaking Changes ## Breaking Changes
Please note that there are some breaking changes with the new version. Please note that there are some breaking changes with the new version.
It is tried to keep the breaking changes as small as possible, so they should not have much impact for the most users: It is tried to keep the breaking changes as small as possible, so they should not have much impact for the most users:
* PHP 7.2.5 is required now (Part-DB 0.5 supported PHP 5.4+, Part-DB 0.6 7.0). * PHP 7.2.5 is required now (Part-DB 0.5 required PHP 5.4+, Part-DB 0.6 PHP 7.0).
PHP 7.2.5 (or newer) is shipped by all current major Linux distros now (and can be installed by third party sources on others), PHP 7.2.5 (or newer) is shipped by all current major Linux distros now (and can be installed by third party sources on others),
Releases are available for Windows too, so almost everybody should be able to use PHP 7.2.5 Releases are available for Windows too, so almost everybody should be able to use PHP 7.2.5
* Console access highly required. The installation of composer and frontend dependencies require console access, also * Console access highly required. The installation of composer and frontend dependencies require console access, also
@ -16,6 +16,8 @@ It is tried to keep the breaking changes as small as possible, so they should no
It is possible to migrate your existing BBCode to Markdown via `php bin/console php bin/console app:convert-bbcode`. It is possible to migrate your existing BBCode to Markdown via `php bin/console php bin/console app:convert-bbcode`.
* Server exceptions are not logged to Event log anymore. For security reasons (exceptions can contain sensitive informations) * Server exceptions are not logged to Event log anymore. For security reasons (exceptions can contain sensitive informations)
exceptions are only logged to server log (by default under './var/log'), so only the server admins can access it. exceptions are only logged to server log (by default under './var/log'), so only the server admins can access it.
* Profile labels are now saved in Database (before they were saved in a seperate JSON file). The profiles of legacy Part-DB versions can not be imported into new Part-DB 1.0
* Label placeholders now use the `[[PLACEHOLDER]]` format instead of `%PLACEHOLDER%`. Also some placeholders has changed.
## Upgrade process ## Upgrade process
1. Upgrade your existing Part-DB version the newest Part-DB 0.5.* version (in the moment Part-DB 0.5.8), like 1. Upgrade your existing Part-DB version the newest Part-DB 0.5.* version (in the moment Part-DB 0.5.8), like