{"id":13814420,"url":"https://github.com/softwaremill/codebrag","last_synced_at":"2025-05-15T03:34:35.126Z","repository":{"id":7396685,"uuid":"8726352","full_name":"softwaremill/codebrag","owner":"softwaremill","description":"Your daily code review tool","archived":true,"fork":false,"pushed_at":"2018-07-09T17:15:15.000Z","size":15201,"stargazers_count":651,"open_issues_count":68,"forks_count":96,"subscribers_count":94,"default_branch":"master","last_synced_at":"2024-08-04T04:05:47.902Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://www.codebrag.com","language":"Scala","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/softwaremill.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2013-03-12T11:33:31.000Z","updated_at":"2024-04-24T09:22:59.000Z","dependencies_parsed_at":"2022-09-02T17:02:33.681Z","dependency_job_id":null,"html_url":"https://github.com/softwaremill/codebrag","commit_stats":null,"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/softwaremill%2Fcodebrag","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/softwaremill%2Fcodebrag/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/softwaremill%2Fcodebrag/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/softwaremill%2Fcodebrag/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/softwaremill","download_url":"https://codeload.github.com/softwaremill/codebrag/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225326480,"owners_count":17456950,"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":[],"created_at":"2024-08-04T04:01:57.123Z","updated_at":"2024-11-19T09:30:46.638Z","avatar_url":"https://github.com/softwaremill.png","language":"Scala","funding_links":[],"categories":["Scala"],"sub_categories":[],"readme":"# Codebrag\n\nTHIS PROJECT IS NOT MAINTAINED! FEEL FREE TO FORK :)\n\n[![Build Status](https://travis-ci.org/softwaremill/codebrag.svg)](https://travis-ci.org/softwaremill/codebrag)\n\nBelow is a **developer guide** if you want to hack on Codebrag yourself.\n\n**If you are looking for general information on the project, [please see the main website](http://codebrag.com/).**\n\nIf you are just looking for installation or upgrade instructions,\nplease refer to the [wiki](https://github.com/softwaremill/codebrag/wiki).\n\n[Changelog](CHANGELOG.md)\n[WebHooks](WEBHOOKS.adoc)\n\nDeveloper guide\n---\n\nPrerequisites:\n\n1. sbt 0.13.6\n2. nodejs 0.10.13 or newer (make sure `node` and `npm` are available on `PATH`)\n\nQuick Start\n---\n\n1. Configure `local.conf` in the `codebrag` home directory basing on `codebrag-rest/src/main/resources/application.conf.template`\n2. Checkout a SVN/Git repository to chosen `repos-root` folder - Codebrag won't do that for you!\n3. Navigate to the `codebrag` home directory\n4. Execute `./run.sh` script\n5. Default browser should open at `localhost:9090`\n\nWorking with the application:\n---\n1. Go to project dir\n2. Configure `local.conf` in the `codebrag` home directory basing on `codebrag-rest/src/main/resources/application.conf.template`\n3. Start sbt with `sbt`\n4. Open project in your favorite IDE\n5. Run backend server on jetty with `~ container:start`. Project will be recompiled \u0026 redeployed every time Scala sources will be changed.\n6. Go to `codebrag-ui` project. If this is your first attempt, run `npm install`. This will install all the dependencies required to start UI Codebrag application. Then run `./node_modules/.bin/grunt server`. If you have `grunt` installed globally you can use `grunt server` instead.\n\nDefault browser should open at [http://localhost:9090](http://localhost:9090)\n\nFor more information about UI application build please consult [README in codebrag-ui project](codebrag-ui/)\n\nRun Codebrag with stubbed backend\n---\n\nYou may want to run Codebrag without backend services e.g. to work on frontend side (HTML, CSS).\nFollow the instructions in `codebrag-ui` project README to install all required stuff.\nWhen Codebrag is run, appending `?nobackend` to any URL lets you work with stubbed data - with no backend required.\n\nSkipping slow tests\n---\n\nIf you want to execute tests from sbt and skip slow cases requiring database, you can execute following command:\n`test-only * -- -l requiresDb`\n\nLogging\n---\n\nFor logging we use SLF4J+Logback. An example configration file can be found in `scripts/logback-example.xml`. To use a\nconfiguration file, either place a `logback.xml` file in the bundle, or specify an external one using\n`-Dlogback.configurationFile`.\n\nCreate distribution\n---\n\n1. Start sbt, change subproject: `project codebrag-dist`\n2. Run: `assembly`\n3. This will create a fat-jar. To start Codebrag with the given configuration, run:\n\n````\njava -Dconfig.file=[path to .conf file] -Dlogback.configurationFile=logback.xml -jar codebrag-dist-assembly-[version].jar\n````\n\nH2 console\n---\n\nWhen using the embedded SQL storage, it may be useful to browse the tables. H2 provides consoles, which can be run\nas follows:\n\n1. For a web console, run from sbt: `codebrag-dao/runH2Console`\n2. For a command line console, run `java -Dconfig.file=codebrag.conf -cp [path to the fat JAR] com.softwaremill.codebrag.dao.sql.H2ShellConsole`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsoftwaremill%2Fcodebrag","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsoftwaremill%2Fcodebrag","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsoftwaremill%2Fcodebrag/lists"}