{"id":20917959,"url":"https://github.com/avigoldman/peashooter","last_synced_at":"2026-04-27T14:03:28.939Z","repository":{"id":81615019,"uuid":"88331265","full_name":"avigoldman/peashooter","owner":"avigoldman","description":"A server to store simple logs bundled with a live dashboard","archived":false,"fork":false,"pushed_at":"2017-04-16T02:17:52.000Z","size":27,"stargazers_count":2,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-12-28T01:51:05.182Z","etag":null,"topics":["express","heroku","knex","logger","logging","remote"],"latest_commit_sha":null,"homepage":"https://peashooter.herokuapp.com/","language":"JavaScript","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/avigoldman.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":"2017-04-15T07:22:25.000Z","updated_at":"2019-11-22T16:56:07.000Z","dependencies_parsed_at":"2023-03-07T06:00:13.985Z","dependency_job_id":null,"html_url":"https://github.com/avigoldman/peashooter","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/avigoldman/peashooter","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/avigoldman%2Fpeashooter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/avigoldman%2Fpeashooter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/avigoldman%2Fpeashooter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/avigoldman%2Fpeashooter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/avigoldman","download_url":"https://codeload.github.com/avigoldman/peashooter/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/avigoldman%2Fpeashooter/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32339290,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-26T23:26:28.701Z","status":"online","status_checked_at":"2026-04-27T02:00:06.769Z","response_time":128,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["express","heroku","knex","logger","logging","remote"],"created_at":"2024-11-18T16:36:43.775Z","updated_at":"2026-04-27T14:03:28.920Z","avatar_url":"https://github.com/avigoldman.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Peashooter\n\nA server to store simple logs bundled with a live dashboard.\n\nI imagine the best use case is for developing IoT projects.\n\nI made this for a friends project who needed an easy way to log output from his home-made 360 camera. (Yes it is as cool as it sounds - read about it on [his blog](http://dcc.umd.edu/portfolio/bbock)). \n\n\n## Heroku Deployment\n\nYou can deploy directly to heroku with the following button to get up and running immediately. \u003cbr\u003e\n[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy)\n\n## Manual Deployment\n\nTo deploy manually clone the repo, install the dependencies, and run the database migrations. In order to run locally you must configure your database connection in `knexfile.js`. In production set the database settings in `DATABASE_URL` env variable.\n\n```\ngit clone https://github.com/aymg/peashooter.git\ncd peashooter\nnpm install\n./node_modules/.bin/knex migrate:latest\n```\n\nLastly, start up the server and log things. To start the server locally run `npm start`. In production, run `npm run prod`.\n\n## Configuration\n\nName | Description | Default | Required\n---|---|---|---\n`DATEBASE_URL` | The database connection configuration for production. |  | Yes (Heroku sets this automatically with the [Postgresql addon](https://elements.heroku.com/addons/heroku-postgresql))\n`PEASHOOTER_TITLE` | The title for the logger. This shows up a in the title tag and top of the dashboard. | peashooter | No\n`PEASHOOTER_USERNAME` | The username for basic auth. Set a username and password to enable basic auth. |  | No\n`PEASHOOTER_PASSWORD` | The username for basic auth. Set a username and password to enable basic auth. |  | No\n`PEASHOOTER_HIDE_INFO` | Whether or not to hide the about and sample code in the dashboard. If set to false, basic auth details are made visible on the protected dashboard. | `false` | No\n\n## Usage\n\n### The dashboard\nThe dashboard is located at the home page of the server. You can view the demo [here](https://peashooter.herokuapp.com). The dashboard uses [socket.io](https://socket.io) to automatically show all new updates.\n\n\n### The API\n\n#### `POST` `/log`\nAdds a new entry in the log.\n\n**Note:** `Content-Type` header must be `text/plain`.\n\nReturns a JSON object with the `text`, `id`, and `created_at` timestamp.\n\n```\n{\n  \"id\": 20,\n  \"text\": \"Your logged message.\",\n  \"created_at\":\"2017-04-16T01:58:40.558Z\"\n}\n```\n\n#### `POST` `/clear`\nClears out all the log entries.\n\nReturns a JSON object with the total number of lines cleared.\n\n```\n{\n  \"count\": 5\n}\n```\n\n\n#### `GET` `/list`\nRetrieves the full list of log entries.\n\nReturns an array of JSON objects.\n```\n[\n  {\n    \"id\": 20,\n    \"text\": \"Your message goes here\",\n    \"created_at\": \"2017-04-16T01:58:40.558Z\"\n  },\n  {\n    \"id\": 21,\n    \"text\": \"Your message goes here\",\n    \"created_at\": \"2017-04-16T02:07:42.334Z\"\n  }\n]\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Favigoldman%2Fpeashooter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Favigoldman%2Fpeashooter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Favigoldman%2Fpeashooter/lists"}