{"id":20272299,"url":"https://github.com/steemit/faucet","last_synced_at":"2025-08-15T22:33:42.044Z","repository":{"id":27954967,"uuid":"99782826","full_name":"steemit/faucet","owner":"steemit","description":"Steemit Account Creation Web Application","archived":false,"fork":false,"pushed_at":"2025-05-07T02:28:34.000Z","size":7505,"stargazers_count":24,"open_issues_count":114,"forks_count":43,"subscribers_count":16,"default_branch":"master","last_synced_at":"2025-06-23T11:51:29.256Z","etag":null,"topics":["faucet","steem"],"latest_commit_sha":null,"homepage":"","language":"CSS","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/steemit.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2017-08-09T08:18:05.000Z","updated_at":"2024-12-13T15:29:58.000Z","dependencies_parsed_at":"2023-02-14T19:45:56.886Z","dependency_job_id":"8aba4e8a-5446-47e1-8ed0-25cccd20a01c","html_url":"https://github.com/steemit/faucet","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/steemit/faucet","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/steemit%2Ffaucet","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/steemit%2Ffaucet/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/steemit%2Ffaucet/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/steemit%2Ffaucet/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/steemit","download_url":"https://codeload.github.com/steemit/faucet/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/steemit%2Ffaucet/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":269200377,"owners_count":24377431,"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","status":"online","status_checked_at":"2025-08-07T02:00:09.698Z","response_time":73,"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":["faucet","steem"],"created_at":"2024-11-14T12:42:46.965Z","updated_at":"2025-08-07T04:32:52.811Z","avatar_url":"https://github.com/steemit.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Steem faucet\n\n## Install\nDownload and install Node.js \u003e= 7.7.1 then run\n```\nyarn install\n```\n\n## Init database\n\nSet up and run migrations directly from the terminal using Sequelize CLI. Here is how to do:\n```\nyarn exec -- sequelize db:migrate --url 'mysql://username:password@hostname:port/database'\n```\n\nIf your local db server does not support SSL, change the `ssl` option to `false` in `db/config/config.json`.\n\nTo seed the database with seed users:\n```\nyarn exec -- sequelize db:seed:all --url 'mysql://username:password@hostname:port/database'\n```\n\nSeed data can be added at: `db/seeders`\n\nTo start a-fresh:\n```\nyarn exec -- sequelize db:migrate:undo:all --url 'mysql://username:password@hostname:port/database'\n```\n\n#### Example one-liner\n```\nyarn exec -- sequelize db:migrate:undo:all --url 'mysql://root@localhost:3306/faucet' \u0026\u0026 yarn exec -- sequelize db:migrate --url 'mysql://root@localhost:3306/faucet' \u0026\u0026 yarn exec -- sequelize db:seed:all --url 'mysql://root@localhost:3306/faucet'\n```\n\n## Configure\n\nCopy `.env.example` to `.env` and edit as needed. (`.env-admin.example` for faucet-admin)\n\n## Run\n### Faucet:\n```\nenv $(tr \"\\\\n\" \" \" \u003c .env) yarn start-dev # or just start, if you don't want nodemon\n```\n### Faucet-Admin\nSee the readme in `/admin`\n\n## Docker\n\nA Dockerfile is supplied. You will need to configure the app with environment variables.\nSee the file [.env.example](.env.example) for a full list of what you will need.\n\nWhen running the Docker image locally, you will probably need to bind your mysqld to not only localhost\nbut also the IP used in Docker's network. You can then specify this IP in `DATABASE_URL`.\n\nYou can build and start the Docker image like this:\n\n```\nBRANCH=\"$(git rev-parse --abbrev-ref HEAD)\"\ndocker build -t=\"$USER/faucet:$BRANCH\" .\ndocker run -it -p 3000:3000 --env-file=.env \"$USER/faucet:$BRANCH\"\n```\n\n## Debugging\n\n#### VSCode:\nAdd the following to `.vscode/launch.json` configurations array:\n```json\n  {\n    \"type\": \"node\",\n    \"request\": \"launch\",\n    \"name\": \"nodemon\",\n    \"runtimeExecutable\": \"${workspaceRoot}/node_modules/nodemon/bin/nodemon.js\",\n    \"program\": \"${workspaceFolder}/bin/www\",\n    \"restart\": true,\n    \"sourceMaps\": true,\n    \"outFiles\": [],\n    \"console\": \"integratedTerminal\",\n    \"internalConsoleOptions\": \"neverOpen\",\n    \"args\": [\n        \"--ignore src\",\n        \"| bunyan -o short\"\n    ],\n    \"envFile\": \"${workspaceFolder}/.env\",\n  }\n```\n\n## Testing\n\nThe `test` command will run three other scripts in sequence: static analysis (`eslint`), unit and integration tests (`jest`), and dependency security check (`nsp`).\n\nYou do need to supply dummy values for some required environment variables. Do so like this:\n\n```\nenv $(tr \"\\\\n\" \" \" \u003c .env.example) yarn test\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsteemit%2Ffaucet","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsteemit%2Ffaucet","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsteemit%2Ffaucet/lists"}