feature: Update compose file to use registry image

📄 docs: Update readme
This commit is contained in:
Keith Solomon
2025-02-09 19:16:10 -06:00
parent ae3aca120f
commit c8c40ee515
2 changed files with 34 additions and 21 deletions

View File

@@ -12,10 +12,39 @@ BillTrak is a web application designed to help users manage and track their bill
## Technologies Used
- HTML, CSS, JavaScript
- HTML, Tailwind CSS, JavaScript
- Chart.js for data visualization
- Docker for containerization
## Usage
1. Copy the `bills-sample.db` file to `bills.db` in a folder docker can access. This will be the SQLite database used to store bill data.
2. Start the container using `docker compose up -d` with the following `docker-compose.yml` configuration:
```yaml
services:
app:
container_name: BillTrak
restart: unless-stopped
image: ghcr.io/solo-web-works/billtrak:main
ports:
- "8888:80" # Map port 8080 on the host to port 80 in the container. Change the left side to change the host port.
volumes:
# - .:/var/www/html # Mount the current directory for live development
- ./data/bills.db:/var/www/html/data/bills.db # Persist SQLite data
```
3. Access the application at http://localhost:8888
## Roadmap
- Add feature to import bills from CSV files
- Add feature to export bills to CSV files
- Add authentication and user accounts
- Add notifications for upcoming bills
- Got an idea? Open an issue!
## Contributing
Contributions are welcome! Please open an issue or submit a pull request for any improvements or bug fixes.

View File

@@ -2,28 +2,12 @@ services:
app:
container_name: BillTrak
restart: unless-stopped
build:
context: .
dockerfile: Dockerfile
# depends_on:
# - redis
# environment:
# - REDIS_HOST=redis
# - REDIS_PORT=6379
image: ghcr.io/solo-web-works/billtrak:main
ports:
- "8888:80" # Map port 8080 on the host to port 80 in the container
- "8888:80" # Map port 8888 on the host to port 80 in the container. Change the left side to change the host port.
volumes:
- .:/var/www/html # Mount the current directory for live development
# Mount the current directory for live development
# - .:/var/www/html
- ./data/bills.db:/var/www/html/data/bills.db # Persist SQLite data
# redis:
# container_name: redis
# restart: unless-stopped
# image: redis:latest
# ports:
# - "6379:6379"