git-truck 0.0.0-aebd64d → 0.0.0-afc155f

package/README.md

@@ -1,89 +1,44 @@
-# Git Truck 🚛
+# Git Truck 🚛 · [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/git-truck/git-truck/blob/main/LICENSE) [![Git Truck on NPM](https://img.shields.io/npm/v/git-truck)](https://www.npmjs.com/git-truck)
 
-Git-Truck provides you with a truckload of visualizations for your git repository, and find out if your project has a good [truck factor](https://www.agileadvice.com/2005/05/15/agilemanagement/truck-factor/):
+Git Truck is a tool that provides you with a truckload of visualizations of your git repository.
 
+With Git Truck you can:
 
-### 1. The files in your system where you have a single contributor (i.e., truck-factor = 1)
+- See who worked on different parts of the project
+- Get an overview of the file structure
+- See where there is the most activity in your project
+- See how your project has looked at different points in time
 
-<img width="1912" alt="image" src="https://user-images.githubusercontent.com/464519/167393939-8d683732-4583-44fe-99a3-36c818761bcb.png">
+|                                                                                           |                                                                                               |
+| ----------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
+| <img src="./teaser-images/readme1.png" alt="Where has the most work been done recently?"> | <img src="./teaser-images/readme2.png" alt="Who worked on different subsystems in the past?"> |
 
-
-### 2. How the various developers contribute to your codebase
-
-<img width="1913" alt="image" src="https://user-images.githubusercontent.com/464519/167394548-ca66665a-a699-44d7-8a97-bc7309c72f8a.png">
-
-
-
-### 3. The parts of the system that are most often changed
-
-<img width="1912" alt="image" src="https://user-images.githubusercontent.com/464519/167395118-6a4f50f4-5f37-4e0d-bcc8-144797b83e65.png">
-
-
-### 4. You can also merge multiple developer accounts
-
-<img width="1907" alt="image" src="https://user-images.githubusercontent.com/464519/167394405-67bd5b5d-be50-444e-8a1f-68af083a6cba.png">
-
-
-## [Prerequisites](#prerequisites)
-
-To use Git Truck, you will need to have the following programs installed:
-
-- [Node.js](https://nodejs.org/en/) 16.13 or newer
-- npm 6.14 or newer
-- [git](https://git-scm.com/downloads) 2.29 or newer
-
-To check if these programs are installed, and what version you have, run `node --version`, `npm --version` and `git --version`. If any of these are not installed on your system, or are just very old, they can be installed from the links above. Note that `npm` is installed along with `node`.
+You can read more about the features in the [feature overview](https://git-truck.github.io/git-truck/GitTruckTeaser), [in papers about Git Truck](https://github.com/git-truck/papers/blob/master/README.md), or just try it and start exploring your projects!
 
 ## [Get started](#get-started)
 
-1. Within a git repository, or a directory containing git repositories, run the command `npx git-truck@latest`.
-2. Press `y` if it asks you to download the package.
-3. The application will now open in your default browser.
-
-**Git Truck is part of a research study, so please fill out our [short survey](https://forms.gle/9wCCAw6zae7wuwZQ6) after trying out the tool. Thanks!**
-
-## [I got an error or I want to give feedback, what do i do?](#i-got-an-error-or-i-want-to-give-feedback-what-do-i-do)
-
-Please open an issue [here](https://github.com/git-truck/git-truck/issues) where you describe your problem. Please include git version, node version, npm version, operating system, and an image of the problem would be great too!
-
-If you have any suggestions about new features, or things that you think should be different, also feel free to open an issue.
-
-## [Advanced use](#advanced-use)
+1. In your terminal, navigate to a git repository or a folder containing several repositories
 
-Run `npx git-truck` in the root of a git repository, that you want to visualize:
+2. Run the command `npm install -g git-truck@latest` to install or update Git Truck.
 
-```sh
-npx git-truck [args]
-```
+3. Now you can run Git Truck using the command `git truck`
 
-### [Arguments](#arguments)
+4. The application will now open in your default browser. Happy trucking!
 
-|         arg          |                              description                              |   default value    |
-| :------------------: | :-------------------------------------------------------------------: | :----------------: |
-|       `--path`       |                 path to a folder or a git repository                  | current directory  |
-|       `--log`        | output log level. See [here](./src/analyzer/log.server.ts) for values |         -          |
-|       `--port`       |                      port to use for the program                      |        3000        |
-| `--invalidate-cache` |                    bypass analyzer cache manually                     |         -          |
+> [!NOTE]
+> To use Git Truck, you will need to have the following programs installed:
+>
+> - [Node.js](https://nodejs.org/en/) 22.0.0 or newer and npm 10.0 or newer
+> - [git](https://git-scm.com/downloads) 2.29 or newer
+>
+> Check your installed versions using `node --version`, `npm --version` and `git --version`.
 
-**Note:** Using `--invalidate-cache` will cause the analyzer to run every time the client talks to the server.
+## [What makes Git Truck different?](#what-makes-git-truck-different)
 
-### [Configuration](#configuration)
+🔒 Private by design
 
-You can add a `truckconfig.json` file to the root of your project, where you can define the arguments you want.
-Additionally you can define which git-aliases should be considered as the same person using `unionedAuthors`. If provided, the first name in the array is used as the name of the person.
-You can also define files to ignore.
+🏝️ Works offline
 
-**Example:**
+🤷 Git provider agnostic - works with any git repository
 
-```json
-{
-  "log": "debug",
-  "branch": "main",
-  "unionedAuthors": [
-    ["Bob", "Bobby Bob"],
-    ["Alice", "aliiii", "alice alice"]
-  ],
-  "hiddenFiles": ["package-lock.json", "*.bin", "*.svg"],
-  "invalidateCache": true
-}
-```
+😊 No tracking, no ads, no cloud, no servers, no subscription

package/build/client/assets/ErrorPage-C9wxOLZ3.js

@@ -0,0 +1 @@
+import{G as e,t}from"./jsx-runtime-DwrGJl10.js";import{P as n,i as r}from"./util-Dk4mpAYe.js";var i=e(t());function a({className:e,message:t,children:a}){return(0,i.jsxs)(`div`,{className:r(`app-container`,e),children:[(0,i.jsx)(`div`,{}),(0,i.jsx)(`div`,{className:`grid h-full w-full place-items-center px-4 py-10`,children:(0,i.jsxs)(`div`,{className:`flex max-w-2xl flex-col items-center gap-3 text-center`,children:[(0,i.jsx)(`img`,{src:n,alt:`Git Truck`,className:`w-full max-w-sm min-w-0`}),(0,i.jsx)(`div`,{className:`text-4xl leading-tight font-extrabold`,children:t}),a]})})]})}export{a as t};

package/build/client/assets/FullscreenButton-VKTZLH_E.js

@@ -0,0 +1 @@
+import{G as e,t}from"./jsx-runtime-DwrGJl10.js";import"./util-Dk4mpAYe.js";t();

package/build/client/assets/RepoTabs-CrEuVPGR.js

@@ -0,0 +1 @@
+import{G as e,M as t,N as n,a as r,j as i,t as a}from"./jsx-runtime-DwrGJl10.js";import{at as o,g as s,lt as c}from"./util-Dk4mpAYe.js";var l=e(a());function u(){let e=n(),a=i(),u=t(r(`/view/commits`));return(0,l.jsx)(s,{large:!0,group:{"/details":`Details`,"/commits":`Commits`},iconMap:{"/details":o,"/commits":c},defaultValue:u?`/commits`:`/details`,onChange:t=>{e(r(`/view${t}`)+a.search,{state:a.state})}})}export{u as t};

package/build/client/assets/_-BMGoK87-.js

@@ -0,0 +1 @@
+import{B as e,G as t,l as n,t as r}from"./jsx-runtime-DwrGJl10.js";import"./util-Dk4mpAYe.js";import{t as i}from"./ErrorPage-C9wxOLZ3.js";var a=t(r(),1),o=e(function(){return(0,a.jsx)(i,{message:`404 - Page Not Found`,children:(0,a.jsx)(n,{className:`btn btn--primary mt-4`,to:`/`,children:`Go back home`})})});export{o as default};

package/build/client/assets/browse-Cw49S7Tv.js

@@ -0,0 +1 @@
+import"./jsx-runtime-DwrGJl10.js";import{M as e,j as t}from"./util-Dk4mpAYe.js";export{t as default,e as meta};

package/build/client/assets/clear-cache-Cs_lJ97d.js

@@ -0,0 +1 @@
+import"./jsx-runtime-DwrGJl10.js";import"./util-Dk4mpAYe.js";import{n as e}from"./clear-cache-v_vLpJth.js";export{e as default};

package/build/client/assets/clear-cache-v_vLpJth.js

@@ -0,0 +1 @@
+import{A as e,B as t,G as n,O as r,j as i,l as a,t as o}from"./jsx-runtime-DwrGJl10.js";import{N as s,i as c,nt as l,ut as u}from"./util-Dk4mpAYe.js";var d=n(o(),1);function f({redirectPath:e,className:t=``}={}){let n=i(),a=r({key:`clear-cache-form`}),o=`/clear-cache?${new URLSearchParams({redirect:e??n.pathname+n.search}).toString()}`,s=a.state!==`idle`;return(0,d.jsx)(a.Form,{action:o,method:`post`,children:(0,d.jsxs)(`button`,{type:`submit`,disabled:s,className:c(`btn btn--danger`,t),title:`Click here if you are experiencing issues`,children:[(0,d.jsx)(u,{path:l,className:`hover-swap inline-block h-full`}),s?`Clearing...`:`Clear all data`]})},a.state)}var p=t(function(){let{versionInfo:t}=e();return(0,d.jsx)(d.Fragment,{children:(0,d.jsxs)(`div`,{className:`app-container flex flex-col gap-2 p-2`,children:[(0,d.jsx)(`div`,{className:`card`,children:(0,d.jsx)(s,{installedVersion:t.installedVersion,latestVersion:t.latestVersion})}),(0,d.jsxs)(`div`,{className:`card`,children:[(0,d.jsx)(`h1`,{className:`text-2xl font-bold`,children:`Clear Git Truck cache`}),(0,d.jsx)(`p`,{children:`This will clear all analyzed results and reset the database cache. This is only necessary if you are experiencing issues.`}),(0,d.jsxs)(`div`,{className:`flex h-full place-items-center gap-2 rounded-lg border bg-amber-500/70 p-4 text-white`,children:[(0,d.jsx)(u,{path:l,className:`inline-block h-12`}),(0,d.jsxs)(`div`,{children:[(0,d.jsx)(`span`,{className:`font-bold`,children:`Warning: `}),(0,d.jsx)(`span`,{children:`Merged authors and hidden files will be reset.`})]})]}),(0,d.jsxs)(`div`,{className:`flex justify-end gap-2`,children:[(0,d.jsx)(a,{to:`/`,className:`btn btn--text`,children:`Go back`}),(0,d.jsx)(f,{redirectPath:`/`})]})]})]})})});export{p as n,f as t};