mirror of
https://github.com/michaelstaake/mainty.git
synced 2026-04-16 19:40:13 +00:00
Updated Readme
This commit is contained in:
28
README.md
28
README.md
@@ -1,6 +1,6 @@
|
||||
# Mainty
|
||||
|
||||
A simple PHP web app for tracking vehicle maintenance records. Free, simple, open source, and self-hosted. Runs on any Apache/PHP web server, or use Docker. Uses SQLite for easy backup, with built-in Export via JSON or HTML so you can import that data into something else or print records for your mechanic or the next owner of your vehicle.
|
||||
A simple PHP web app for tracking vehicle maintenance records. Free, simple, open source, and self-hosted. Use Docker, or host it on any Apache/PHP web server. Uses SQLite for easy backup, with built-in Export via JSON or HTML so you can import that data into something else or print records for your mechanic or the next owner of your vehicle.
|
||||
|
||||
## Requirements
|
||||
|
||||
@@ -10,7 +10,15 @@ A simple PHP web app for tracking vehicle maintenance records. Free, simple, ope
|
||||
|
||||
## Installation
|
||||
|
||||
### Option 1: Traditional Web Server
|
||||
### Option 1: Docker
|
||||
|
||||
```bash
|
||||
docker-compose up -d
|
||||
```
|
||||
|
||||
Then open http://localhost:8080
|
||||
|
||||
### Option 2: Traditional Web Server
|
||||
|
||||
1. Upload the entire folder to your web server
|
||||
2. Rename `example.htaccess` to `.htaccess`
|
||||
@@ -22,22 +30,6 @@ A simple PHP web app for tracking vehicle maintenance records. Free, simple, ope
|
||||
5. If everything is configured correctly, you'll see the setup page
|
||||
6. Set your password to initialize the database
|
||||
|
||||
### Option 2: Docker
|
||||
|
||||
```bash
|
||||
docker-compose up -d
|
||||
```
|
||||
|
||||
Then open http://localhost:8080
|
||||
|
||||
## First Time Setup
|
||||
|
||||
When you first access the app, you'll be prompted to:
|
||||
1. Create a password
|
||||
2. Initialize the database
|
||||
|
||||
That's it! You're ready to start tracking your vehicle maintenance.
|
||||
|
||||
## Need help? Want to learn more? Go to the official GitHub!
|
||||
|
||||
https://github.com/michaelstaake/mainty
|
||||
|
||||
Reference in New Issue
Block a user