Add README.md with project description and usage instructions
This commit is contained in:
parent
a15c976106
commit
2b21c79eff
40
README.md
40
README.md
@ -0,0 +1,40 @@
|
||||
# LocalWeb Collections
|
||||
|
||||
Een PHP MVC applicatie voor het beheren van collecties van onderdelen, gebouwd met Composer, Twig, en FastRoute. Draait in een LXC container.
|
||||
|
||||
## Features
|
||||
|
||||
- **Onderdelen Beheer**: Voeg, bewerk, verwijder en filter onderdelen.
|
||||
- **Categorieën**: Organiseer onderdelen in hiërarchische categorieën.
|
||||
- **Zoeken en Filteren**: Zoek op naam en filter op categorie.
|
||||
- **Afbeeldingen**: Upload afbeeldingen voor onderdelen.
|
||||
- **Locatie**: Sla locatie informatie op voor onderdelen.
|
||||
- **QR Codes**: Automatisch gegenereerde QR codes voor elk onderdeel, met printbare stickers.
|
||||
- **Meertalig**: Ondersteuning voor Nederlands en Engels.
|
||||
|
||||
## Installatie
|
||||
|
||||
1. Zorg voor een LXC container 'www' met Apache, PHP, en Composer.
|
||||
2. Clone de repository naar /var/www/localhost in de container.
|
||||
3. Run `composer install` in de container.
|
||||
4. Stel de database in: `collections.sqlite` wordt automatisch aangemaakt.
|
||||
5. Start Apache en ga naar http://localhost.
|
||||
|
||||
## Gebruik
|
||||
|
||||
- **Overzicht**: Bekijk alle onderdelen met filters.
|
||||
- **Onderdelen Toevoegen**: Gebruik het formulier om nieuwe onderdelen toe te voegen met afbeelding en locatie.
|
||||
- **Bewerken**: Klik op 'Edit' om onderdelen te wijzigen.
|
||||
- **Verwijderen**: Klik op 'Delete' om onderdelen te verwijderen.
|
||||
- **QR Printen**: Klik op 'Print QR' om een sticker te printen.
|
||||
- **Categorieën**: Beheer categorieën via de zijbalk.
|
||||
|
||||
## Ontwikkeling
|
||||
|
||||
- **Linting**: Geen specifieke tool, volg PSR-12.
|
||||
- **Testing**: Geen tests, gebruik curl voor API testing.
|
||||
- **Commits**: Elke wijziging heeft een git commit.
|
||||
|
||||
## Licentie
|
||||
|
||||
MIT
|
||||
Loading…
x
Reference in New Issue
Block a user