wrench-turn

README

Wrench Turn

Self-hosted, flexible maintenance tracker for your cars, bikes, and everything in between

WARNING: This project is under active development in an alpha state, effectively an MVP. Would not recommend using yet unless you plan to contribute in some way, otherwise a beta release will be coming soon. This will be where everyday self hosters would likely benefit from the service.

Branches

develop: The latest, unstable, branch. Where all commits are made to, and where all contributing branches are branched from. Though tested first, likelihood of broken things is fairly good.

main: stable channel/branch. should pretty much always match the latest release branch

release-vX.X.X[-stage]: particular version/release, e.g. v1.0.0-alpha, v.4.2.0

Running (Production)

1. Clone repo, open in terminal: git clone https://github.com/okdv/wrench-turn.git && cd wrench-turn
2. Create .env.production file from .env.development: cp .env.development .env.production
3. Edit .env.production accordingly, need to change the below, but other vars may need editing depending on implementation:
   • NODE_ENV=production
   • JWT_KEY=YOUR_CUSTOM_SECRET_KEY_DONT_COMMIT_OR_LEAVE_DEFAULT

Docker (recommended)

1. Edit compose.yaml accordingly, mainly port mapping. .env.production should match port mapping in compose.yaml.
2. Build and run sudo docker-compose up

Bare metal (not recommended)

Backend

1. Install go Note: check the image version used in backend.Dockerfile if unsure which version to use. Usually assume latest stable version.
2. Run go build, may need to adjust commands for your particular OS
3. Run generated build, ./wrench-turn, ./wrench-turn.exe, etc.

Frontend

1. Install node or nvm Note: check the image version used in frontend.Dockerfile if unsure which version to use. Usually assume latest stable version.
2. open frontend cd frontend
3. Install node modules npm i
4. Run node build npm run build

Static (recommended)

1. Run the generated build dir (/wrench-turn/frontend/build) with the desired web server, such as NGINX

Using Node (not recommended)

1. Run npm run preview