The Franciscus Material Management is an application build with the Symfony Framework that allows the users to manage the loaning of materials. At our Scouting group, the materials are shared between multiple teams. This management tool primarily makes sure the materials are not used at the same time, while also providing features to allow for easy management in general.
- This project is set up with PHP version 7.4 in combination with Composer. So make sure they are installed.
- When the project is downloaded, first don't forget to run
composer install
to download all dependencies. - Then you can start a local server to run the project with
symfony server:start
. - The next step is to create the database with its tables, which can be done with
php bin/console doctrine:database:create
and thenphp bin/console doctrine:migrations:migrate -n
. - For local development, you can then fill the database with dummy data with
php bin/console doctrine:fixtures:load
. - To activate the front-end, run
npm install
and nextnpm run dev
. During development it might be your preference to runnpm run watch
in the background to automatically recompile your front-end related changes. - Finally, to easily open the website you can use
symfony open:local
.
You can update the data for the materials via a CSV file with the own implemented command php bin/console import-material [filename]
. The filename is optional and will load a .csv file in the /data directory.
The admin section includes ordering and filtering options and comes with a custom dashboard with useful information.