https://github.com/robinbastiaan/franciscus-material-management

Material management & loan system for Franciscusgroup.
https://github.com/robinbastiaan/franciscus-material-management

php scouting symfony

Last synced: 18 days ago
JSON representation

Material management & loan system for Franciscusgroup.

• Host: GitHub
• URL: https://github.com/robinbastiaan/franciscus-material-management
• Owner: RobinBastiaan
• Created: 2021-04-17T20:30:37.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2025-01-12T20:46:56.000Z (23 days ago)
• Last Synced: 2025-01-12T21:30:24.013Z (23 days ago)
• Topics: php, scouting, symfony
• Language: PHP
• Homepage:
• Size: 597 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Description

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.  

# Installation

1. This project is set up with PHP version 7.4 in combination with Composer. So make sure they are installed.

1. When the project is downloaded, first don't forget to run `composer install` to download all dependencies.

1. Then you can start a local server to run the project with `symfony server:start`.

1. The next step is to create the database with its tables, which can be done with `php bin/console doctrine:database:create` and then `php bin/console doctrine:migrations:migrate -n`.

1. For local development, you can then fill the database with dummy data with `php bin/console doctrine:fixtures:load`.

1. To activate the front-end, run `npm install `and next `npm run dev`. During development it might be your preference to run `npm run watch` in the background to automatically recompile your front-end related changes.

1. Finally, to easily open the website you can use `symfony open:local`. 

# Data import

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.

# Screenshots

The admin section includes ordering and filtering options and comes with a custom dashboard with useful information.

![Screenshot Admin](docs/screenshots/admin-dashboard.png)

# Visualization of the codebase

![Visualization of the codebase](docs/diagram.svg)