Skip to content

iqfareez/gitinit

Repository files navigation

GitInit

GitInit is a simple API servive that returns the latest commit of a GitHub repository.

Initially, the gitinit is supposed to show repository's initial commit (like firstcommit). But the implementation is somewhat difficult and I wanted to ship this project asap.

Usage

Basic

To use the API, simply make a GET request to https://gitinit-psi.vercel.app/api/<owner>/<repo>. Example: https://gitinit-psi.vercel.app/api/iqfareez/gitinit

Shields.IO badge

Also available with Shields.IO variants. Docs https://shields.io/badges/endpoint-badge

Endpoint Badge

![Endpoint Badge](https://img.shields.io/endpoint?url=https://gitinit-psi.vercel.app/api/iqfareez/gitinit?shields=yes)

The badge label can be customized by supply label to the query string.

Endpoint Badge

![Endpoint Badge](https://img.shields.io/endpoint?url=https://gitinit-psi.vercel.app/api/iqfareez/gitinit?shields=yes&label=My+Custom+Label)

Getting Started

Create a new .evn.local file in the root of the project and add the following:

GH_PAT=your_github_personal_access_token

Then, run the following command to install the dependencies:

npm install

Finally, run the development server:

npm run dev

Open http://localhost:3000 with your browser to see the result.

You can start editing the page by modifying app/page.tsx. The page auto-updates as you edit the file.

This project uses next/font to automatically optimize and load Inter, a custom Google Font.

Learn More

To learn more about Next.js, take a look at the following resources:

You can check out the Next.js GitHub repository - your feedback and contributions are welcome!

Deploy on Vercel

The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.

Check out our Next.js deployment documentation for more details.