https://github.com/md-talim/git-implementation-ts

A TypeScript implementation of Git's core features, built as part of the "Build Your Own Git" challenge.
https://github.com/md-talim/git-implementation-ts

build-your-own-x git typescript

Last synced: about 2 months ago
JSON representation

A TypeScript implementation of Git's core features, built as part of the "Build Your Own Git" challenge.

• Host: GitHub
• URL: https://github.com/md-talim/git-implementation-ts
• Owner: Md-Talim
• Created: 2024-11-28T16:52:13.000Z (about 2 months ago)
• Default Branch: main
• Last Pushed: 2024-11-29T14:35:46.000Z (about 2 months ago)
• Last Synced: 2024-12-09T12:15:22.728Z (about 2 months ago)
• Topics: build-your-own-x, git, typescript
• Language: TypeScript
• Homepage:
• Size: 10.7 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
[![progress-banner](https://backend.codecrafters.io/progress/git/c2c3c1dc-2eaf-4f3a-9640-d445ba24e0ff)](https://app.codecrafters.io/users/codecrafters-bot?r=2qF)

This is a starting point for TypeScript solutions to the

["Build Your Own Git" Challenge](https://codecrafters.io/challenges/git).

In this challenge, you'll build a small Git implementation that's capable of

initializing a repository, creating commits and cloning a public repository.

Along the way we'll learn about the `.git` directory, Git objects (blobs,

commits, trees etc.), Git's transfer protocols and more.

**Note**: If you're viewing this repo on GitHub, head over to

[codecrafters.io](https://codecrafters.io) to try the challenge.

# Passing the first stage

The entry point for your Git implementation is in `app/main.ts`. Study and

uncomment the relevant code, and push your changes to pass the first stage:

```sh

git commit -am "pass 1st stage" # any msg

git push origin master

```

That's all!

# Stage 2 & beyond

Note: This section is for stages 2 and beyond.

1. Ensure you have `bun (1.1)` installed locally

1. Run `./your_program.sh` to run your Git implementation, which is implemented

   in `app/main.ts`.

1. Commit your changes and run `git push origin master` to submit your solution

   to CodeCrafters. Test output will be streamed to your terminal.

# Testing locally

The `your_program.sh` script is expected to operate on the `.git` folder inside

the current working directory. If you're running this inside the root of this

repository, you might end up accidentally damaging your repository's `.git`

folder.

We suggest executing `your_program.sh` in a different folder when testing

locally. For example:

```sh

mkdir -p /tmp/testing && cd /tmp/testing

/path/to/your/repo/your_program.sh init

```

To make this easier to type out, you could add a

[shell alias](https://shapeshed.com/unix-alias/):

```sh

alias mygit=/path/to/your/repo/your_program.sh

mkdir -p /tmp/testing && cd /tmp/testing

mygit init

```