{"id":17928520,"url":"https://github.com/evilsocket/joe","last_synced_at":"2025-09-17T22:33:39.441Z","repository":{"id":57642678,"uuid":"220066730","full_name":"evilsocket/joe","owner":"evilsocket","description":"The Swiss Army knife for backend engineers.","archived":false,"fork":false,"pushed_at":"2021-03-12T14:59:47.000Z","size":74,"stargazers_count":95,"open_issues_count":0,"forks_count":11,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-12-30T21:41:53.184Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","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/evilsocket.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}},"created_at":"2019-11-06T18:47:37.000Z","updated_at":"2024-10-07T04:36:41.000Z","dependencies_parsed_at":"2022-08-27T21:50:58.609Z","dependency_job_id":null,"html_url":"https://github.com/evilsocket/joe","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/evilsocket%2Fjoe","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/evilsocket%2Fjoe/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/evilsocket%2Fjoe/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/evilsocket%2Fjoe/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/evilsocket","download_url":"https://codeload.github.com/evilsocket/joe/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":233429749,"owners_count":18674992,"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-10-28T21:03:42.789Z","updated_at":"2025-09-17T22:33:34.118Z","avatar_url":"https://github.com/evilsocket.png","language":"Go","readme":"# Joe\n\nJoe is a tool to automatically build a REST API, its documentation and charts around SQL queries and their resulting\n data. \n\nIn a way it is an anti-[ORM](https://en.wikipedia.org/wiki/Object-relational_mapping): its purpose is to help backend engineers versioning\n, annotating, exposing and charting the queries that can't be implemented or aren't worth implementing in the backend\n main business logic and that they would normally keep on .txt or .sql files.\n\n## How to Install\n\n```sh\ngo get -u github.com/evilsocket/joe/cmd/joe\n```\n\n## Example\n\nFirst create an `/etc/joe/joe.conf` configuration file with the access credentials for the database:\n\n```conf\n# CHANGE THIS: use a complex secret for the JWT token generation\nAPI_SECRET=02zygnJs5e0bBLJjaHCinWTjfRdheTYO\n\nDB_HOST=joe-mysql\nDB_DRIVER=mysql\nDB_USER=joe\nDB_PASSWORD=joe\nDB_NAME=joe\nDB_PORT=3306\n```\n\nThen create the `admin` user (this command will generate the file `/etc/joe/users/admin.yml`):\n\n```sh\nsudo mkdir -p /etc/joe/users\nsudo joe -new-user admin -token-ttl 6 # JWT tokens for this user expire after 6 hours\n```\n\nFor query and chart examples [you can check this repository](https://github.com/evilsocket/pwngrid-queries-joe). Once\n you have your `/etc/joe/queries` folder with your queries, you can:\n\nGenerate markdown documentation:\n\n```sh\njoe -doc /path/to/document.md\n```\n\nStart the joe server:\n\n```sh\njoe -conf /etc/joe/joe.conf -data /etc/joe/queries -users /etc/joe/users\n```\n\n## Why the name Joe?        \n        \nThe software is a very generic middleware that doesn't have a very specific business logic but adapts to the queries\n and the data, so one of the most generic and short names looked like a good idea. You can also think about \"Joe\" as\n  that coworker you can always ask to run a query on the backend for you.\n        \n## License\n\n`joe` is made with ♥  by [@evilsocket](https://twitter.com/evilsocket) and it is released under the GPL3 license.","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fevilsocket%2Fjoe","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fevilsocket%2Fjoe","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fevilsocket%2Fjoe/lists"}