Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jenojp/filegrid
Simple API for exploring files, packaged with Docker
https://github.com/jenojp/filegrid
Last synced: 24 days ago
JSON representation
Simple API for exploring files, packaged with Docker
- Host: GitHub
- URL: https://github.com/jenojp/filegrid
- Owner: jenojp
- Created: 2022-10-01T10:32:16.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2022-10-03T16:43:44.000Z (about 2 years ago)
- Last Synced: 2024-10-03T10:24:16.144Z (about 1 month ago)
- Language: Python
- Size: 35.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# filegrid
[](https://dev.azure.com/jenopizzaro/negspacy/_build/latest?definitionId=4&branchName=main)
Simple API for exploring files, packaged with Docker.
If given a directory, the API will return the contents of the directory, along with common attributes (e.g., owner, size, permissions).
If given a file, the contents of the text file will be returned.
## Installation
1. Ensure Docker daemon is running
2. Run installation script to create Docker image
```bash
#from ~/filegrid
sh install.sh
```
## Usage
1. Clone repo
2. Run script, specifying root directory (absolute link needed)
```bash
run.sh /Users/tedison/Documents
```
3. Make HTTP request to view files or folders
```bash
curl --request GET 'http://localhost:80//foo/foobar'
```
Note: `/foo/foobar` is a file path. You must supply `//` between the `http://address:port` and the `{file path}` for the API to properly recognize your path.
Sample Response (Directory):
```json
{
"type": "dir",
"results": [
{
"name": "baz",
"dir": false,
"owner": "root",
"size": 546,
"permission": 33188
},
{
"name": "foobar",
"dir": true,
"owner": "root",
"size": 96,
"permission": 16877
}
]
}
```
Sample Response (File):
```json
{
"type": "file",
"contents": "Sept 30 (Reuters) - The ruptures on the Nord Stream natural gas pipeline system under the Baltic Sea have led to what is likely the biggest single release of climate-damaging methane ever recorded, the United Nations Environment Programme said on Friday.\n\nA huge plume of highly concentrated methane, a greenhouse gas far more potent but shorter-lived than carbon dioxide, was detected in an analysis this week of satellite imagery by researchers associated with UNEP's International Methane Emissions Observatory, or IMEO, the organization said."
}
```
4. Make HTTP request to add a folder.
```bash
curl --location --request POST 'http://localhost:80//foo/newfolder' \
--header 'Content-Type: application/json' \
--data-raw '{
"dir": true
}'
```
5. Make HTTP request to add a file.
```bash
curl --location --request POST 'http://localhost:80//foo/newfile' \
--header 'Content-Type: application/json' \
--data-raw '{
"dir": false,
"contents":"this is a new file"
}'
```
6. Make HTTP request to delete a file or folder. Modify "dir" parameter in body of request to be `true` (deleting a folder) or `false` (deleting a file).
```bash
curl --location --request DELETE 'http://localhost:80//foo/newfolder' \
--header 'Content-Type: application/json' \
--data-raw '{
"dir": true
}'
```
## API Documentation
Navigate to `localhost:80/docs` to view Swagger API documentation.
## Uninstall and cleanup
Simply execute the following to teardown the docker container and remove the built image
```bash
sh cleanup.sh
```