forked from rahulsainlll/git-trace
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
e4367de
commit 1afaebb
Showing
1 changed file
with
41 additions
and
18 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,37 +1,60 @@ | ||
# git-trace | ||
<div align="center"> | ||
<h1 align="center">Git-trace</h1> | ||
<h5>Open Source save issues and repositories endpoint</h5> | ||
</div> | ||
|
||
git-trace is a tool for viewing, and bookmarking gitHub repositories and issues effortlessly keep track of your favorite projects and issues with ease! | ||
<div align="center"> | ||
<a href="https://git-trace.vercel.app">git-trace.com</a> | ||
</div> | ||
<br/> | ||
|
||
## features | ||
Git-trace is a tool for viewing, and bookmarking gitHub repositories and issues effortlessly keep track of your projects with ease! | ||
|
||
## Features | ||
|
||
git-Trace allows you to: | ||
Search Repositories: Quickly find GitHub repositories by owner and name. | ||
View Issues: Explore and view issues related to the repositories you’re interested in. | ||
Bookmark Items: Save repositories and issues for quick access, ensuring you never lose track of important projects. | ||
|
||
## frontend | ||
|
||
the frontend is built with Next.js and React, providing a seamless user experience. It features a clean and intuitive interface for searching repositories and viewing issues, with responsive design (under construction). | ||
## Frontend | ||
|
||
The frontend is built with Next.js and React, providing a seamless user experience. It features a clean and intuitive interface for searching repositories and viewing issues, with responsive design (under construction). | ||
|
||
## backend | ||
|
||
git-Trace’s backend handles repository and issue searches through gitHub’s api, and supports user authentication for bookmarking features. The system is powered by prisma and neon db for robust data management. | ||
## Backend | ||
|
||
Git-Trace’s backend handles repository and issue searches through gitHub’s api, and supports user authentication for bookmarking features. The system is powered by prisma and neon db for robust data management. | ||
|
||
## running it yourself | ||
|
||
you are welcome to self host git-trace. to get started, make sure that: | ||
## Contributing | ||
|
||
- you are using python 3.9/3.10; | ||
- port 8001 (used by the inference server) is free. | ||
Please read through our [contributing guide](./CONTRIBUTING.md) before starting any work. | ||
|
||
then follow the steps below: | ||
# Star History | ||
|
||
1. set up the evn file | ||
2. run `npm install` | ||
3. run the development server: `npm run dev` | ||
<picture> | ||
<source | ||
media="(prefers-color-scheme: dark)" | ||
srcset=" | ||
https://api.star-history.com/svg?repos=rahulsainlll/git-trace&type=Date&theme=dark | ||
" | ||
/> | ||
|
||
<source | ||
media="(prefers-color-scheme: light)" | ||
srcset=" | ||
https://api.star-history.com/svg?repos=rahulsainlll/git-trace&type=Date | ||
" | ||
/> | ||
<img | ||
alt="Star History Chart" | ||
src="https://api.star-history.com/svg?repos=rahulsainlll/git-trace&type=Date&theme=dark" | ||
/> | ||
</picture> | ||
|
||
## feature requests | ||
# Contributors | ||
|
||
if you have any feature idea, feel free to use the issue tracker to let me know! | ||
<a href="https://github.com/rahulsainlll/git-trace/graphs/contributors"> | ||
<img src="https://contrib.rocks/image?repo=rahulsainlll/git-trace" /> | ||
</a> |