cphipps/lubelog
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updated website and re-organized readme

Browse Source
This commit is contained in:
DESKTOP-GENO133\IvanPlex
2024-02-22 22:36:56 -07:00
parent 3d96984735
commit 6e87c2d5cc
3 changed files with 22 additions and 45 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@@ -1,12 +1,8 @@
![image](https://github.com/hargata/lubelog/assets/155338622/545debcd-d80a-44da-b892-4c652ab0384a) ![image](https://github.com/hargata/lubelog/assets/155338622/545debcd-d80a-44da-b892-4c652ab0384a)
A self-hosted, open-source vehicle service records and maintenance tracker. Self-Hosted, Open-Source, Web-Based Vehicle Maintenance and Fuel Mileage Tracker
Visit our website: https://lubelogger.com Website: https://lubelogger.com
Support this project by [Subscribing on Patreon](https://patreon.com/LubeLogger) or [Making a Donation](https://buy.stripe.com/aEU9Egc8DdMc9bO144)
Note: Commercial users are required to maintain an active Patreon subscripton to be compliant with our licensing model.
## Why ## Why
Because nobody should have to deal with a homemade spreadsheet or a shoebox full of receipts when it comes to vehicle maintenance. Because nobody should have to deal with a homemade spreadsheet or a shoebox full of receipts when it comes to vehicle maintenance.
@@ -22,11 +18,11 @@ Try it out before you download it! The live demo resets every 20 minutes.
[Live Demo](https://demo.lubelogger.com) Login using username "test" and password "1234" [Live Demo](https://demo.lubelogger.com) Login using username "test" and password "1234"
## Download ## Download
LubeLogger is available as both a Docker image and a Windows Standalone Executable. LubeLogger is available as both a Docker Image and a Windows Standalone Executable.
Read this [Getting Started Guide](https://docs.lubelogger.com/Getting%20Started) on how to download either of them Read this [Getting Started Guide](https://docs.lubelogger.com/Getting%20Started) on how to download either of them
### Docker Setup (Manual Build) ### Docker Setup (Manual Build for Advanced Users)
1. Install Docker 1. Install Docker
2. Clone this repo 2. Clone this repo
3. CHECK culture in .env file, default is en_US, also setup SMTP for user management if you want that. 3. CHECK culture in .env file, default is en_US, also setup SMTP for user management if you want that.
@@ -44,3 +40,11 @@ Read this [Getting Started Guide](https://docs.lubelogger.com/Getting%20Started)
- CsvHelper - CsvHelper
- Chart.js - Chart.js
- Drawdown - Drawdown
## License
LubeLogger utilizes a dual-licensing model, see [License](/LICENSE) for more information
## Support
Support this project by [Subscribing on Patreon](https://patreon.com/LubeLogger) or [Making a Donation](https://buy.stripe.com/aEU9Egc8DdMc9bO144)
Note: Commercial users are required to maintain an active Patreon subscripton to be compliant with our licensing model.

BIN
docs/favicon.ico Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 4.2 KiB

47
docs/index.html
View File

@@ -2,6 +2,7 @@
<head> <head>
<meta charset="utf-8" /> <meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" />
<link rel="icon" type="image/x-icon" href="favicon.ico">
<title>LubeLogger</title> <title>LubeLogger</title>
<link href="https://cdn.jsdelivr.net/npm/bootstrap@5.3.2/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-T3c6CoIi6uLrA9TneNEoa7RxnatzjcDSCmG1MXxSR1GAsXEV/Dwwykc2MPK8M2HN" crossorigin="anonymous"> <link href="https://cdn.jsdelivr.net/npm/bootstrap@5.3.2/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-T3c6CoIi6uLrA9TneNEoa7RxnatzjcDSCmG1MXxSR1GAsXEV/Dwwykc2MPK8M2HN" crossorigin="anonymous">
<style> <style>
@@ -30,7 +31,7 @@
<div class="col-12 col-sm-6 col-md-2"><a class="btn btn-dark" href="#features">Features</a></div> <div class="col-12 col-sm-6 col-md-2"><a class="btn btn-dark" href="#features">Features</a></div>
<div class="col-12 col-sm-6 col-md-2"><a class="btn btn-dark" href="#demo">Demo</a></div> <div class="col-12 col-sm-6 col-md-2"><a class="btn btn-dark" href="#demo">Demo</a></div>
<div class="col-12 col-sm-6 col-md-2"><a class="btn btn-dark" href="#download">Download</a></div> <div class="col-12 col-sm-6 col-md-2"><a class="btn btn-dark" href="#download">Download</a></div>
<div class="col-12 col-sm-6 col-md-2"><a class="btn btn-dark" href="https://docs.lubelogger.com">Docs</a></div> <div class="col-12 col-sm-6 col-md-2"><a class="btn btn-dark" href="https://docs.lubelogger.com">Documentation</a></div>
<div class="col-12 col-sm-6 col-md-2"><a class="btn btn-dark" href="https://github.com/hargata/lubelog">GitHub Repo</a></div> <div class="col-12 col-sm-6 col-md-2"><a class="btn btn-dark" href="https://github.com/hargata/lubelog">GitHub Repo</a></div>
</div> </div>
<hr> <hr>
@@ -94,11 +95,11 @@
</div> </div>
</div> </div>
<button class="carousel-control-prev" type="button" data-bs-target="#carouselGallery" data-bs-slide="prev"> <button class="carousel-control-prev" type="button" data-bs-target="#carouselGallery" data-bs-slide="prev">
<span class="carousel-control-prev-icon" aria-hidden="true"></span> <span class="carousel-control-prev-icon" style='filter:inherit;' aria-hidden="true"></span>
<span class="visually-hidden">Previous</span> <span class="visually-hidden">Previous</span>
</button> </button>
<button class="carousel-control-next" type="button" data-bs-target="#carouselGallery" data-bs-slide="next"> <button class="carousel-control-next" type="button" data-bs-target="#carouselGallery" data-bs-slide="next">
<span class="carousel-control-next-icon" aria-hidden="true"></span> <span class="carousel-control-next-icon" style='filter:inherit;' aria-hidden="true"></span>
<span class="visually-hidden">Next</span> <span class="visually-hidden">Next</span>
</button> </button>
</div> </div>
@@ -141,7 +142,7 @@
</div> </div>
<div class="col-12 d-flex justify-content-center"> <div class="col-12 d-flex justify-content-center">
<p class="lead"> <p class="lead">
Live demo available <a href="https://demo.lubelogger.com">here</a> Live demo available <a class='link-light link-offset-2 link-underline-opacity-25 link-underline-opacity-100-hover' href="https://demo.lubelogger.com">here</a>
</p> </p>
</div> </div>
<div class="col-12 d-flex justify-content-center"> <div class="col-12 d-flex justify-content-center">
@@ -151,44 +152,20 @@
<hr> <hr>
<div class="row" id="download"> <div class="row" id="download">
<div class="col-12 d-flex justify-content-center"> <div class="col-12 d-flex justify-content-center">
<h6 class="display-6 text-center">Where to Download</h6> <h6 class="display-6 text-center">Download</h6>
</div> </div>
</div> </div>
<div class="row"> <div class="row">
<div class="col-12 d-flex justify-content-center"> <div class="col-12 d-flex justify-content-center">
<p class="lead"> <p class="lead">
LubeLogger is released exclusively as a Docker Image via the GitHub Container Repository(GHCR) LubeLogger is available as both a Docker Image and a Windows Standalone Executable(EXE)
</p> </p>
</div> </div>
<div class="col-12 d-flex justify-content-center"> <div class="col-12 d-flex justify-content-center">
<p class="lead"> <p class="lead">
To pull down the Docker Image, run Read this <a class='link-light link-offset-2 link-underline-opacity-25 link-underline-opacity-100-hover' href='https://docs.lubelogger.com/Getting%20Started'>Getting Started Guide</a> on how to download either of them
</p> </p>
</div> </div>
<div class="col-12 d-flex justify-content-center">
<p><code>docker pull ghcr.io/hargata/lubelogger:latest</code></p>
</div>
<div class="col-12 d-flex justify-content-center">
<p class="lead">
Check the <a href="https://github.com/hargata/lubelog/" target="_blank">GitHub repository</a> and clone the "docker-compose.yml" and ".env" file onto your computer.
</p>
</div>
<div class="col-12 d-flex justify-content-center">
<p class="lead">
Navigate to the directory where those two files are located, then run
</p>
</div>
<div class="col-12 d-flex justify-content-center">
<p><code>docker-compose up</code></p>
</div>
<div class="col-12 d-flex justify-content-center">
<p class="lead">
Navigate to the URL the service is listening on, the default is
</p>
</div>
<div class="col-12 d-flex justify-content-center">
<p><code>http://localhost:8080</code></p>
</div>
</div> </div>
<hr> <hr>
<div class="row"> <div class="row">
@@ -196,15 +173,11 @@
<h6 class="display-6 text-center">About</h6> <h6 class="display-6 text-center">About</h6>
</div> </div>
<div class="col-12 d-flex justify-content-center"> <div class="col-12 d-flex justify-content-center">
<p class="lead">LubeLogger is proudly developed in Price Utah by Hargata Softworks. <p class="lead">LubeLogger is proudly developed in <a class='link-light link-offset-2 link-underline-opacity-25 link-underline-opacity-100-hover' href="https://www.visitutah.com/Places-To-Go/Cities-and-Towns/Price" target="_blank">Price Utah</a> by <a class='link-light link-offset-2 link-underline-opacity-25 link-underline-opacity-100-hover' href='mailto:hargatasoftworks@gmail.com'>Hargata Softworks</a>
</p> </p>
</div> </div>
<div class="col-12 d-flex justify-content-center"> <div class="col-12 d-flex justify-content-center">
<p class="lead"><a href="https://www.patreon.com/LubeLogger">Support us on Patreon</a> <p class="lead"><a class='link-light link-offset-2 link-underline-opacity-25 link-underline-opacity-100-hover' href="https://www.patreon.com/LubeLogger">Support us on Patreon</a> or <a class='link-light link-offset-2 link-underline-opacity-25 link-underline-opacity-100-hover' href='https://buy.stripe.com/aEU9Egc8DdMc9bO144'>Donate on Stripe</a>
</p>
</div>
<div class="col-12 d-flex justify-content-center">
<p class="lead">For more information regarding Price Utah, click <a href="https://www.visitutah.com/Places-To-Go/Cities-and-Towns/Price" target="_blank">here</a>
</p> </p>
</div> </div>
</div> </div>