{"id":28376626,"url":"https://github.com/apiaryio/polls-api","last_synced_at":"2025-06-26T14:31:45.621Z","repository":{"id":27532305,"uuid":"31013532","full_name":"apiaryio/polls-api","owner":"apiaryio","description":"Polls is an example web API that allows consumers to view polls and vote in them.","archived":true,"fork":false,"pushed_at":"2023-04-21T21:13:50.000Z","size":123,"stargazers_count":46,"open_issues_count":3,"forks_count":22,"subscribers_count":15,"default_branch":"master","last_synced_at":"2025-05-30T00:07:29.874Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","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/apiaryio.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":"2015-02-19T12:05:33.000Z","updated_at":"2024-11-08T09:04:07.000Z","dependencies_parsed_at":"2022-09-02T09:10:54.601Z","dependency_job_id":null,"html_url":"https://github.com/apiaryio/polls-api","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/apiaryio/polls-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apiaryio%2Fpolls-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apiaryio%2Fpolls-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apiaryio%2Fpolls-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apiaryio%2Fpolls-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/apiaryio","download_url":"https://codeload.github.com/apiaryio/polls-api/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apiaryio%2Fpolls-api/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262084803,"owners_count":23256297,"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-05-30T00:07:26.618Z","updated_at":"2025-06-26T14:31:45.588Z","avatar_url":"https://github.com/apiaryio.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Polls API\n\n[![Apiary Documentation](https://img.shields.io/badge/Apiary-Documented-blue.svg)](http://docs.pollsapi.apiary.io/)\n[![Circle CI Status](https://img.shields.io/circleci/project/apiaryio/polls-api.svg)](https://circleci.com/gh/apiaryio/polls-api/tree/master)\n\nThis is a Python implementation of a Polls API, an API that allows consumers to\nview polls and vote in them. Take a look at the\n[API Documentation](http://docs.pollsapi.apiary.io/). We've\ndeployed an instance of this [API](https://polls.apiblueprint.org/) for testing.\n\n## Development Environment\n\nYou can configure a development environment with the following:\n\n**NOTE**: *These steps assume you have Python along with [pipenv](https://docs.pipenv.org/install/) installed.*\n\n```bash\n$ pipenv install\n$ pipenv run python manage.py migrate\n```\n\n### Running the tests\n\n```bash\n$ python manage.py test\n```\n\n### Running the development server\n\n```bash\n$ pipenv run python manage.py runserver\n```\n\n### Running dredd\n\nProviding [dredd](http://dredd.readthedocs.org/en/latest/) has been\ninstalled, you can run the following to run dredd against the Polls API:\n\n```bash\n$ pipenv run dredd\n```\n\n### Running via docker\n\n#### Running the development server\n\n```bash\n$ docker-compose up web\n$ open \"http://$(docker-machine ip default):8080\"\n```\n\n#### Running tests in Docker\n\n```bash\n$ docker-compose run shell python manage.py test\n```\n\n## Deploying\n\n### Deploying on Heroku\n\nClick the button below to automatically set up the Polls API in an app\nrunning on your Heroku account.\n\n[![Deploy to Heroku](https://www.herokucdn.com/deploy/button.png)](https://heroku.com/deploy?template=https://github.com/apiaryio/polls-api)\n\nOnce you've deployed, you can easily clone the application and alter the\nconfiguration to disable features:\n\n```bash\n$ heroku clone -a new-app-name\n$ heroku config:set POLLS_CAN_VOTE_QUESTION=false\n$ heroku config:set POLLS_CAN_CREATE_QUESTION=false\n$ heroku config:set POLLS_CAN_DELETE_QUESTION=false\n```\n\n### Deploying on Heroku using Docker\n\nIf you'd like to, you may use Docker on Heroku instead. Refer to the [Heroku\nContainer Registry and Runtime\nGuide](https://devcenter.heroku.com/articles/container-registry-and-runtime#getting-started)\nfor detailed instructions. Providing you have Docker installed you can follow\nthe following steps:\n\n```bash\n$ heroku container:login\n$ heroku container:push web\n$ heroku container:release web\n```\n\n## License\n\npolls-api is released under the MIT license. See [LICENSE](LICENSE).\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapiaryio%2Fpolls-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fapiaryio%2Fpolls-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapiaryio%2Fpolls-api/lists"}