You've already forked gun-manager
update Docker image reference and enhance README with application details
This commit is contained in:
29
README.md
29
README.md
@@ -1,6 +1,27 @@
|
|||||||
|
# Gun Manager
|
||||||
|
|
||||||
|
Gun Manager is a web application for managing a gun inventory, built with Go and React. It allows users to add, edit,
|
||||||
|
and delete gun records, as well as view them in a user-friendly interface.
|
||||||
|
|
||||||
|
## 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
|
```shell
|
||||||
docker run --rm \
|
mkdir -p data && \
|
||||||
-v $(pwd)/data:/data \
|
curl -sSL https://gitea.siteworxpro.com/siteworxpro/gun-manager/raw/branch/master/docker-compose.yml | docker compose -f - up -d
|
||||||
-p 8000:8000 \
|
|
||||||
scr.siteworxpro.com/gun-manager:v0.0.3 -database /data/gun_inventory.sqlite
|
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Accessing the Application
|
||||||
|
|
||||||
|
Once the application is running, you can access it in your web browser at `https://localhost`.
|
||||||
@@ -19,7 +19,7 @@ services:
|
|||||||
- "--entrypoints.web.http.redirections.entrypoint.permanent=true"
|
- "--entrypoints.web.http.redirections.entrypoint.permanent=true"
|
||||||
|
|
||||||
api:
|
api:
|
||||||
image: scr.siteworxpro.com/gun-manager:v1.0.0
|
image: siteworxpro/gun-manager:v1.0.0
|
||||||
container_name: gun-manager
|
container_name: gun-manager
|
||||||
labels:
|
labels:
|
||||||
- "traefik.enable=true"
|
- "traefik.enable=true"
|
||||||
|
|||||||
Reference in New Issue
Block a user