msasikanth / timelapse

Leverage Git history, reveal tribal knowledge and understand codebases faster 🔍

Timelapse

Timelapse onboards developers onto codebases before you make that cup of instant noodles!

1. System setup

Step 1 of 5 - JDK 15

Download and install JDK 15 for your OS.

Step 2 of 5 - Node.js

Download and install Node.js 14.17.0 for your platform.

Step 3 of 5 - IntelliJ IDEA

Download and install IntelliJ IDEA.

Step 4 of 5 - IntelliJ Plugin

See IntelliJ Plugin's README for installation and usage.

Step 5 of 5 - Rune CLI

npm install -g rune-cli

2. Project setup

Step 1 of 4 - Clone

The repository has submodules. If you haven't cloned the repository already, run:

git clone --recursive [e-mail]:redgreenio/timelapse.git

If you have already cloned the repository without the --recursive option. Then cd into the project directory and then run,

git submodule update --init --recursive

Step 2 of 4 - Verify & run

cd into the project directory and run the following Gradle tasks.

Windows

gradlew test run

Linux & macOS

./gradlew test run

If the build succeeds, you should be able to see this screen!

Step 3 of 4 - Install Git hooks

Windows

gradlew installGitHooks

Linux & macOS

./gradlew installGitHooks

Step 4 of 4 - Install dev-cli

See dev-cli's README for installation and usage.

3. Other tools

1. Diff (macOS)

To generate unified diffs for reproducing bugs or handling new use cases, make use of the diff utility.

diff -u a.txt b.txt

2. ProGuard

ProGuard can come in handy to de-obfuscate stack traces from production.

The runnable jars are placed inside the /tools/proguard directory.

More documentation

• 🚀 Creating a release

License

Copyright 2021 Red Green, Inc.