{"id":26686143,"url":"https://github.com/actmd/node-system-status","last_synced_at":"2025-04-12T16:52:16.384Z","repository":{"id":18215459,"uuid":"21352880","full_name":"actmd/node-system-status","owner":"actmd","description":"Create your own webapp status page with a Twitter account and this tiny Node.js app","archived":false,"fork":false,"pushed_at":"2019-07-16T15:17:21.000Z","size":141,"stargazers_count":9,"open_issues_count":0,"forks_count":2,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-03-26T11:16:51.247Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/actmd.png","metadata":{"files":{"readme":"README.md","changelog":null,"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":"2014-06-30T13:55:47.000Z","updated_at":"2019-12-06T20:20:51.000Z","dependencies_parsed_at":"2022-09-14T13:52:49.676Z","dependency_job_id":null,"html_url":"https://github.com/actmd/node-system-status","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/actmd%2Fnode-system-status","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/actmd%2Fnode-system-status/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/actmd%2Fnode-system-status/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/actmd%2Fnode-system-status/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/actmd","download_url":"https://codeload.github.com/actmd/node-system-status/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248601285,"owners_count":21131607,"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":"2025-03-26T11:16:57.142Z","updated_at":"2025-04-12T16:52:16.342Z","avatar_url":"https://github.com/actmd.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"node-system-status\n==================\n\nCreate your own webapp status page with a Twitter account and this tiny Node.js app from your friends at [ACT.md](http://act.md).\n\n* [Demo: View ACT.md's status page](http://status.act.md)\n\n# The basics\n\nAt ACT.md, we [use Twitter](https://twitter.com/actmdstatus) to notify our users of upcoming maintenance or, heaven forbid, an unplanned outage. node-system-status shows those messages in a clean and professional way, distinguishing between issues (red), maintenance notices (yellow), and all-clear messages (green) using the hashtags **#issue**, **#maintenance**, and **#ok**.\n\n# Running locally\n\n## Abbreviated four-step process\n\nAssuming you have Node.js and [foreman](https://github.com/strongloop/node-foreman) installed.\n\n1. Clone the repo and `npm install` the dependencies\n2. Copy `config.orig.json` to `config.json` and customize\n3. Copy `twitter_credentials.orig.json` to `twitter_credentials.json` and customize\n4. `nf start` and visit [http://localhost:5000](http://localhost:5000)\n\n## Detailed instructions\n\n1. Clone the repo\n2. Open a terminal window in that directory and install the npm dependencies\n  * `npm install`\n2. Install the [Heroku Toolbelt](https://toolbelt.heroku.com/) if you plan on deploying on Heroku, or just install [foreman](https://github.com/strongloop/node-foreman) to test locally.\n  * `npm install -g foreman`\n2. Copy `config.orig.json` to `config.json` and update it with your own values.\n  * `application_name`: The name of your application, e.g. `ACT.md`\n  * `twitter_handle`: Twitter username you use to post application updates, e.g. `actmdstatus`\n  * `number_of_tweets`: Total number of status tweets to show, e.g. `10`\n  * `help_email`: E-mail address your users should contact if they need additional assistance\n  * `copyright`: Official name for your copyright notice, e.g. `Accountable Care Transactions, Inc`\n3. Create a Twitter API Key and Access Token for node-system-status to use\n  1. Sign into the [Twitter Application Management site](https://apps.twitter.com/) and click \"Create a new app,\" the \"app\" being your new Twitter-based application status website.\n  2. Fill out the form. Leave *Callback URL* empty.\n  3. With your app created, click the \"API Keys\" tab. You'll see your *API Key* and *API Secret* waiting for you.\n  4. At the bottom, click \"Create my access token.\"\n  5. Wait for the token to appear. You'll see an *Access Token* and *Access Token Secret*.\n4. Copy `twitter_credentials.orig.json` to `twitter_credentials.json` and update it with the above keys \u0026 secrets.\n  * `consumer_key`: Your Twitter API Key\n  * `consumer_secret`: Your Twitter API Secret\n  * `access_token_key`: Your Twitter Access Token\n  * `access_token_secret`: Your Twitter Access Token Secret\n5. Start your app\n  * `foreman start`\n  * Visit [http://localhost:5000](http://localhost:5000)\n6. Post status messages to your Twitter account. Messages must include a recognized hashtag to appear.\n  * **#ok** (renders in green)\n  * **#maintenance** (renders in yellow)\n  * **#issue** (renders in red)\n\n# Deploying to Heroku\n\n## Abbreviated four-step process\n\n1. Clone the repo\n2. `heroku login` and `heroku create`\n3. Set all the application variables. (See step 5 below)\n4. `git push heroku master` and open in a browser.\n\n## Detailed instructions\n\n1. Install the [Heroku Toolbelt](https://toolbelt.heroku.com/) and create a Heroku account, if you don't have one.\n2. Clone the repo and open a terminal window in that directory\n3. Log into Heroku\n  * `heroku login`\n4. Create a new Heroku app instance\n  * `heroku create`\n5. Set all the application variables\n  * `heroku config:set APPLICATION_NAME=...`\n  * `heroku config:set TWITTER_HANDLE=...`\n  * `heroku config:set NUMBER_OF_TWEETS=...`  \n  * `heroku config:set HELP_EMAIL=...`\n  * `heroku config:set COPYRIGHT=...`\n  * `heroku config:set TZ=\u003cyour_timezone\u003e`\n  * `heroku config:set TWITTER_CONSUMER_KEY=...`\n  * `heroku config:set TWITTER_CONSUMER_SECRET=...`\n  * `heroku config:set TWITTER_TOKEN_KEY=...`\n  * `heroku config:set TWITTER_TOKEN_SECRET=...`\n6. Deploy to your Heroku instance\n  * `git push heroku master`\n7. Note the URL that's displayed in the response and open that in your browser.\n\n# Acknowledgements\n\n* The \"What is this site?\" text is modeled closely on GitHub's status page text.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Factmd%2Fnode-system-status","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Factmd%2Fnode-system-status","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Factmd%2Fnode-system-status/lists"}