{"id":15444144,"url":"https://github.com/struckchure/file-storage-api","last_synced_at":"2025-04-19T20:23:17.625Z","repository":{"id":137607932,"uuid":"563420949","full_name":"struckchure/file-storage-api","owner":"struckchure","description":"File Storage API acts as a simple version of any cloud storage bucket.","archived":false,"fork":false,"pushed_at":"2025-03-22T02:06:13.000Z","size":53,"stargazers_count":11,"open_issues_count":10,"forks_count":3,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-29T12:51:21.033Z","etag":null,"topics":["buckets","django","django-rest-framework","docker","python","storage-api"],"latest_commit_sha":null,"homepage":"https://file-storage-api.readthedocs.io/en/latest","language":"Python","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/struckchure.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":"2022-11-08T15:21:04.000Z","updated_at":"2025-03-11T22:23:46.000Z","dependencies_parsed_at":null,"dependency_job_id":"340f02bf-2fed-471c-990b-a417d82fe030","html_url":"https://github.com/struckchure/file-storage-api","commit_stats":null,"previous_names":["struckchure/file-storage-api"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/struckchure%2Ffile-storage-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/struckchure%2Ffile-storage-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/struckchure%2Ffile-storage-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/struckchure%2Ffile-storage-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/struckchure","download_url":"https://codeload.github.com/struckchure/file-storage-api/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249792937,"owners_count":21326449,"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":["buckets","django","django-rest-framework","docker","python","storage-api"],"created_at":"2024-10-01T19:39:32.968Z","updated_at":"2025-04-19T20:23:17.588Z","avatar_url":"https://github.com/struckchure.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# File Storage API\n\n[![Docker Image CI](https://github.com/struckchure/file_storage_api/actions/workflows/docker-image.yml/badge.svg)](https://github.com/struckchure/file_storage_api/actions/workflows/docker-image.yml)\n\nRome wasn't built in a day, but `file_storage_api` was 😅\n\nThis is a simple API for storing files. It is designed to be used with the [File Storage Client](https://github.com/struckchure/file-storage-client).\n\nIt can also be used as a standalone API on RESTFul communications over HTTP/HTTPS. By default it runs on port `1276`\n\n# Running image\n\nTo run the container, using `docker`. Pull from any registry, DockerHub or GitHub, both registries are linked to this repository and work exactly the same.\n\n- DockerHub\n\n```sh\n$ docker pull struckchure/file_storage\n$ docker run -p 1276:1276 -it struckchure/file_storage\n```\n\n- GitHub\n\n```sh\n$ docker pull ghcr.io/struckchure/file_storage\n$ docker run -p 1276:1276 -it ghcr.io/struckchure/file_storage\n```\n\n# Running from source\n\nTo run the API from source, you need to have `python3` and `pip3` installed. Then you can install the dependencies and run the API.\n\n```sh\n$ git clone git@github.com:struckchure/file_storage_api.git\n$ cd file_storage_api\n$ pip3 install -r requirements.txt\n$ python3 manage.py runserver 1276\n```\n\n# Using the API\n\n- `POST api/v1/files/` - Upload a file\n\nUpload file using the key `file` in the request body.\\\nExample (using `curl`):\n\n```sh\n$ curl -F \"file=@/path/to/file\" -X POST http://localhost:1276/api/v1/files/\n```\n\n- `GET api/v1/files/` - Get a list of all files\n\nList all files in the database (not sure if you want to do this, but it's there).\\\nExample (using `curl`):\n\n```sh\n$ curl http://localhost:1276/api/v1/files/\n```\n\n- `GET api/v1/files/\u003cfile_id\u003e` - Get a file by ID\n\nGet a file by ID.\\\nExample (using `curl`):\n\n```sh\n$ curl http://localhost:1276/api/v1/files/c678409202e12677e2c4/\n```\n\n- `PUT api/v1/files/\u003cfile_id\u003e` - Update a file by ID\n\nUpdate a file by ID.\\\nExample (using `curl`):\n\n```sh\n$ curl -F \"file=@/path/to/file\" -X PUT http://localhost:1276/api/v1/files/c678409202e12677e2c4/\n```\n\n- `DELETE api/v1/files/\u003cfile_id\u003e` - Delete a file by ID\n\nDelete a file by ID.\\\nExample (using `curl`):\n\n```sh\n$ curl -X DELETE http://localhost:1276/api/v1/files/c678409202e12677e2c4/\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstruckchure%2Ffile-storage-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstruckchure%2Ffile-storage-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstruckchure%2Ffile-storage-api/lists"}