{"id":18675722,"url":"https://github.com/scanapi/demo-api","last_synced_at":"2025-04-12T02:11:39.530Z","repository":{"id":38260374,"uuid":"227714336","full_name":"scanapi/demo-api","owner":"scanapi","description":"This repo is only for demo purposes","archived":false,"fork":false,"pushed_at":"2025-03-24T05:05:54.000Z","size":1345,"stargazers_count":2,"open_issues_count":22,"forks_count":3,"subscribers_count":14,"default_branch":"main","last_synced_at":"2025-04-09T23:12:26.509Z","etag":null,"topics":["api","demo","demo-api","django","django-rest-framework","scanapi"],"latest_commit_sha":null,"homepage":"https://demo.scanapi.dev/","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/scanapi.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2019-12-12T23:19:44.000Z","updated_at":"2024-10-28T15:26:39.000Z","dependencies_parsed_at":"2024-04-14T00:48:35.927Z","dependency_job_id":null,"html_url":"https://github.com/scanapi/demo-api","commit_stats":{"total_commits":68,"total_committers":5,"mean_commits":13.6,"dds":"0.27941176470588236","last_synced_commit":"d0408ea2237af2f7e4abf9067510d74833209c19"},"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scanapi%2Fdemo-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scanapi%2Fdemo-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scanapi%2Fdemo-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scanapi%2Fdemo-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/scanapi","download_url":"https://codeload.github.com/scanapi/demo-api/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248217113,"owners_count":21066633,"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":["api","demo","demo-api","django","django-rest-framework","scanapi"],"created_at":"2024-11-07T09:26:03.415Z","updated_at":"2025-04-12T02:11:39.484Z","avatar_url":"https://github.com/scanapi.png","language":"Python","readme":"![](https://github.com/scanapi/design/raw/main/images/github-hero-dark.png)\n\n# Demo API\n\nThis is an API built only for demo purposes of [ScanAPI](https://github.com/camilamaia/scanapi). It\ncan be accessed at https://demo.scanapi.dev/.\n\n\n## Development\n\n### How to run demo-api locally\n\n\u003e The setup process's prerequisites are [Python 3.6+](https://www.python.org/downloads/), [pip](https://pip.pypa.io/en/stable/installing/) and [git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) installed in your system.\n\n1. **Fork scanapi/demo-api**\n\n* [Fork](https://docs.github.com/en/github/getting-started-with-github/quickstart/fork-a-repo) a repo in your github account such as you get *yourusername*/demo-api. Now that you own a copy of the repo, you can easily clone the repo with the command below so that you can start making changes to the repo.\n\n```\ngit clone https://github.com/\u003cyour username\u003e/demo-api.git\n```\n\n2. **Create and activate a new virtual environment**\n\n* For creating virtual environment we are using the method mentioned in the [Python documentation](https://docs.python.org/3/tutorial/venv.html).\n```\npython3 -m venv DemoAPI\nsource DemoAPI/bin/activate\n```\n\n * Feel free to use any other library like [virtualenv](https://virtualenv.pypa.io/en/latest/) or [virtualenvwrapper](https://virtualenvwrapper.readthedocs.io/en/latest/) for creating a new environment if you have any other prefrences.\n\n3. **Install the demo-api dependencies**\n\n```\ncd demo-api\npip install -r requirements.txt\n```\n\n4. **Make migrations and run the demo-api**\n```\npython manage.py migrate\npython manage.py runserver\n```\n\n* If everything runs smoothly without any errors you should see the API live at http://127.0.0.1:8000/. Feel free to create an issue if run into problems while setting up the project.\n\n## Deployment\n\n Currently the demo-api is hosted on Fly.io. Whenever any branch is merged into the main branch a new deployment is triggered at [demo.scanapi.dev](https://demo.scanapi.dev/api/v1/) via GitHub Actions\n\n You can check the status/activity log of the current deployment as well as the past ones [here](https://github.com/scanapi/demo-api/actions/).\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscanapi%2Fdemo-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fscanapi%2Fdemo-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscanapi%2Fdemo-api/lists"}