updated readme so it's laid out better
This commit is contained in:
17
README.md
17
README.md
@@ -5,13 +5,6 @@ A self-hosted, open-source vehicle service records and maintainence tracker.
|
|||||||
## Why
|
## Why
|
||||||
Because nobody should have to deal with a homemade spreadsheet or a shoebox full of receipts when it comes to vehicle maintainence.
|
Because nobody should have to deal with a homemade spreadsheet or a shoebox full of receipts when it comes to vehicle maintainence.
|
||||||
|
|
||||||
## Docker Setup (Recommended)
|
|
||||||
1. Install Docker
|
|
||||||
2. Clone this repo
|
|
||||||
3. Run `docker build -t lubelogger -f Dockerfile .`
|
|
||||||
4. CHECK docker-compose.yaml and make sure the mounting directories look correct.
|
|
||||||
5. Run `docker-compose up`
|
|
||||||
|
|
||||||
## Dependencies
|
## Dependencies
|
||||||
- Bootstrap
|
- Bootstrap
|
||||||
- LiteDB
|
- LiteDB
|
||||||
@@ -20,7 +13,15 @@ Because nobody should have to deal with a homemade spreadsheet or a shoebox full
|
|||||||
- CsvHelper
|
- CsvHelper
|
||||||
- Chart.js
|
- Chart.js
|
||||||
|
|
||||||
## Docker
|
## Docker Setup (Recommended)
|
||||||
|
1. Install Docker
|
||||||
|
2. Clone this repo
|
||||||
|
3. Run `docker build -t lubelogger -f Dockerfile .`
|
||||||
|
4. CHECK docker-compose.yml and make sure the mounting directories look correct.
|
||||||
|
5. If not using traefik, use docker-compose-notraefik.yml
|
||||||
|
5. Run `docker-compose build`
|
||||||
|
|
||||||
|
##Additional Docker Instructions
|
||||||
|
|
||||||
### manual
|
### manual
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user