Files
gun-manager/README.md

43 lines
1.5 KiB
Markdown

# Gun Manager
![guns](https://gitea.siteworxpro.com/siteworxpro/gun-manager-frontend/raw/commit/156d77850a50fa39dea59c90bddb5ac9486eec89/src/assets/guns.gif)
Gun Manager is a web application for managing a gun inventory, built with Go and Vue. It allows users to add, edit,
and delete gun records, as well as view them in a user-friendly interface.
This application is designed to help gun enthusiasts and collectors keep track of their firearms, including details such
as make, model, caliber, and photos of each gun.
Great for insurance purposes, personal inventory management, or simply for enthusiasts who want to keep a detailed
record of their collection.
## Features
- Add, edit, and delete gun records
- View gun records in a table
- Search and filter gun records
- Responsive design
- Photo upload for each gun record
## Running the Application
To run the Gun Manager application, you need to have Docker installed on your machine. The application uses a SQLite
database to store gun records.
## Prerequisites
- Docker installed on your machine
- A directory named `data` in the current working directory to store the SQLite database file
```shell
mkdir -p data && \
curl -sSL https://gitea.siteworxpro.com/siteworxpro/gun-manager/raw/tag/v1.1.0/docker-compose.yml | docker compose -f - up -d
```
## Accessing the Application
Once the application is running, you can access it in your web browser at [https://localhost](https://localhost).
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE.md) file for details.