{"id":16925141,"url":"https://github.com/hiroppy/demobook","last_synced_at":"2025-03-22T11:31:04.015Z","repository":{"id":66361371,"uuid":"145709584","full_name":"hiroppy/demobook","owner":"hiroppy","description":"Feel free to publish files from anywhere💕","archived":false,"fork":false,"pushed_at":"2023-08-03T04:55:53.000Z","size":3334,"stargazers_count":27,"open_issues_count":5,"forks_count":2,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-18T10:51:33.629Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/hiroppy.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-08-22T12:59:50.000Z","updated_at":"2024-09-23T09:20:06.000Z","dependencies_parsed_at":"2024-10-28T13:17:15.787Z","dependency_job_id":"9351abd9-a842-44a6-89b1-b56bfa33dd83","html_url":"https://github.com/hiroppy/demobook","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hiroppy%2Fdemobook","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hiroppy%2Fdemobook/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hiroppy%2Fdemobook/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hiroppy%2Fdemobook/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hiroppy","download_url":"https://codeload.github.com/hiroppy/demobook/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244951253,"owners_count":20537347,"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-13T20:08:54.865Z","updated_at":"2025-03-22T11:31:04.009Z","avatar_url":"https://github.com/hiroppy.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n  \u003cimg src=\"./media/logo.svg\" /\u003e\n\u003c/div\u003e\n\n[![Travis (.org)](https://img.shields.io/travis/hiroppy/demobook.svg?style=flat-square)](https://travis-ci.org/hiroppy/demobook)\n\n## Introduction\n\n**DemoBook will help the development environment of your work!!**\n\nDemoBook is an application to easily deploy static files and provides CLI and Server.\n\n### Usage\n\n- It is possible to support a review of PR by making CI execute CLI.\n  - Automatically deploys production deliverables(also, like storybook, bundle.js, etc...) to the DemoBook server hosted by a user when CI runs, and then a registered bot notifies PR.\n- It is possible to deploy instantly anywhere\n  - A team member can deploy from each PC without to push to GitHub with 1 command and can easily share to team members\n\n## Feature\n\n- The server can publish random URLs for deployed static files\n- The server can post as a bot to GitHub's PR\n- The server can delete expired static files automatically\n- The CLI does not matter where you run\n\n## Demo\n\n![](./media/demo.gif)\n\n### Top Page\n\n![](./media/top.png)\n\n### Owner Page\n\n![](./media/owner.png)\n\n## Getting Started\n\nWe need to prepare the DemoBook server.\n\n```sh\n$ git clone git@github.com:hiroppy/demobook.git \u0026\u0026 cd demobook \u0026\u0026 npm i \u0026\u0026 cd packages/app\n$ cp .env.sample .env # please edit it\n$ npm run build:client:prod\n$ openssl req -x509 -newkey rsa:2048 -nodes -sha256 -subj '/CN=localhost' \\\n  -keyout key.pem -out cert.pem # if you need\n$ docker-compose -f docker-compose.yml -f docker-compose.prod.yml up -d\n```\n\n### Use a bot and automatically writes some information as a comment in PR\n\nIt is beneficial to register the CLI as a task in CI.  \nDemoBook can notify GitHub by specifying the `--pr` option of the CLI.  \nYou need to write `userName` and `password` in `.env`.\n\n\u003e the format that a bot posts: [#4](https://github.com/hiroppy/demobook/issues/4#issuecomment-416006087)\n\nThis is a sample of how to write in Travis.\n\n\u003cdetails\u003e\n\n```yml\n# travis.yml\nsudo: false\nlanguage: node_js\ncache:\n  directories:\n    - node_modules\nnode_js:\n  - 10\nos:\n  - linux\nbefore_script:\n  - npm i\n  - npm run build\n  - npx @demobook/cli -o onwer-name -r repo-name -t https://your-domain -d dist --pr ${TRAVIS_PULL_REQUEST} -n core\n```\n\n\u003c/details\u003e\n\nIt can be executed locally as well.\n\n## Development\n\n```sh\n$ git clone git@github.com:hiroppy/demobook.git \u0026\u0026 cd demobook \u0026\u0026 npm i \u0026\u0026 cd packages/app\n$ cp .env.sample .env # please edit it\n$ docker-compose up\n$ # if you want to create demos...\n$ cd ../examples\n$ sh local.sh # please edit local.sh(owner name, repository name)\n```\n\n## Respect\n\nRespect the UA of [drone.io](https://drone.io/).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhiroppy%2Fdemobook","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhiroppy%2Fdemobook","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhiroppy%2Fdemobook/lists"}