Git-trace is a tool for viewing, and bookmarking gitHub repositories and issues effortlessly keep track of your projects with ease!
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.
Before you begin, ensure you have the following prerequisites installed on your local machine:
- Node.js: Version 14 or higher
- npm (Node Package Manager): Usually comes with Node.js installation
Follow these instructions to set up Git-trace on your local machine for development or testing purposes:
-
Clone the repository:
Download a copy of the project to your local computer.git clone https://github.com/rahulsainlll/git-trace.git cd git-trace -
Install dependencies:
Install all the necessary libraries and packages.
npm install
-
Set up environment variables:
Copy the provided example .env file and fill in the necessary values.
cp .env.example .env
-
Run the development server:
Start the development server.
npm run dev
-
Build the project: (optional)
Prepare the project for production.
npx next build
-
Explore and Test: (optional)
After following these steps, you can start exploring the app at http://localhost:3000. For more in-depth contribution or development guidelines, please refer to the CONTRIBUTING.md file.
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).
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.
Please read through our contributing guide before starting any work.
