{"id":20784916,"url":"https://github.com/emad-elsaid/codeye","last_synced_at":"2025-05-05T03:23:23.595Z","repository":{"id":66682047,"uuid":"116372986","full_name":"emad-elsaid/codeye","owner":"emad-elsaid","description":"Code insights, statistics of your code, history, contributions and contributors, graphs and more.","archived":false,"fork":false,"pushed_at":"2018-01-21T16:35:02.000Z","size":9715,"stargazers_count":5,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-30T21:41:28.319Z","etag":null,"topics":["git","go","insights"],"latest_commit_sha":null,"homepage":"http://www.emadelsaid.com/codeye","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/emad-elsaid.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-01-05T10:26:23.000Z","updated_at":"2019-02-22T01:34:30.000Z","dependencies_parsed_at":"2023-03-11T00:13:50.666Z","dependency_job_id":null,"html_url":"https://github.com/emad-elsaid/codeye","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emad-elsaid%2Fcodeye","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emad-elsaid%2Fcodeye/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emad-elsaid%2Fcodeye/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emad-elsaid%2Fcodeye/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/emad-elsaid","download_url":"https://codeload.github.com/emad-elsaid/codeye/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252430495,"owners_count":21746670,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["git","go","insights"],"created_at":"2024-11-17T14:34:29.877Z","updated_at":"2025-05-05T03:23:23.585Z","avatar_url":"https://github.com/emad-elsaid.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Codeye (Code Eye)\n[![Go Report Card](https://goreportcard.com/badge/github.com/emad-elsaid/codeye)](https://goreportcard.com/report/github.com/emad-elsaid/codeye)\n[![CircleCI](https://circleci.com/gh/emad-elsaid/codeye.svg?style=shield)](https://circleci.com/gh/emad-elsaid/codeye)\n\n\u003cp align=\"center\"\u003e\n\u003cimg src=\"http://www.emadelsaid.com/images/codeye.png\" width=\"150\" align=\"center\"\u003e\n\u003c/p\u003e\n\nWhen I join a new project I always find it hard to understand the current code\nstructure, its history like when was it started, who worked on it so far, and\nother helpful tips that gives me context about code before diving in the code\nitself, so I decided to build that tool, to be a single binary web server, you\ncan run it in any project, and explore that project code from a web interface.\n\nThe technique itself helped me discover anomalies in code, especially what is so\ncalled legacy code, get an idea about the messy places and have a general plan\nto straighten the project before even diving in the refactoring phase.\n\nIn the beginning I didn't know whether to choose ruby or Go for the\nimplementation, ruby will make it faster to implement it with nice help from\nrails and other gems, and go will give me speed and one binary distribution, so\nI decided to go with Go for these reasons, also I wanted to push my skills\ntowards Go and explore more of this language.\n\n## Installation\n\nDownload the binary for your system from here:\n\n| Windows                                                                                                                                                   | Linux                                                                                                                                               | FreeBSD                                                                                                                                                   | MacOS                                                                                                                                               |\n|-----------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------|\n| [![windows](http://www.emadelsaid.com/images/windows.png)](https://github.com/emad-elsaid/codeye/releases/download/v0.2/codeye_0.2_windows_64-bit.tar.gz) | [![linux](http://www.emadelsaid.com/images/linux.png)](https://github.com/emad-elsaid/codeye/releases/download/v0.2/codeye_0.2_linux_64-bit.tar.gz) | [![freebsd](http://www.emadelsaid.com/images/freebsd.png)](https://github.com/emad-elsaid/codeye/releases/download/v0.2/codeye_0.2_freebsd_64-bit.tar.gz) | [![macos](http://www.emadelsaid.com/images/macos.png)](https://github.com/emad-elsaid/codeye/releases/download/v0.2/codeye_0.2_macOS_64-bit.tar.gz) |\n\nOr latest version from [here](https://github.com/emad-elsaid/codeye/releases/latest)\n\n## Screenshots\n\n![](https://i.imgur.com/PN533rH.png)\n\n## Usage\n\nExecute `codeye` in any git project you have, it will open a port service a web insterface for you to navigate\n\n## Development\n\n### Prerequisite\n\n* You need of course Go installed on your system with `$GOPATH` defined in your shell\n* `go-bindata` installed with `go get -u github.com/jteeuwen/go-bindata/...`\n* [goreleaser](https://goreleaser.com/) for releasing, if you don't want to release then ignore it,\n\n### Having your own fork\n\n* Fork the repository to your account\n* Get the repository `go get github.com/emad-elsaid/codeye`\n* Go there `cd $GOPATH/src/github.com/emad-elsaid/codeye`\n* Rename remote `origin` to `upstream` `git remote rename origin upstream`\n* Add your repository as origin `git remote add origin \u003cyour repository remote url here\u003e`\n* Happy hacking\n\n### Assets\n\nCodeye uses `go-bindata` to generate assets, so if you changed any of the assets you'll need to regenerate them in code.\n\n```bash\ngo generate\n```\n\n\n### Running codeye in another project\n\nI usually execute that command while developing, to run codeye in another project called `news`\n\n```shell\ncd ~/code/news; go run ~/go/src/github.com/emad-elsaid/codeye/cmd/codeye/codeye.go\n```\n\n### Releasing a new version\n\n1. add a tag to the branch and push it\n2. execute `goreleaser`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Femad-elsaid%2Fcodeye","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Femad-elsaid%2Fcodeye","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Femad-elsaid%2Fcodeye/lists"}