https://github.com/forticheprod/quiet-stroll

A service to deliver basic function about the file system
https://github.com/forticheprod/quiet-stroll

glob openapi rocket rust service walk

Last synced: 5 days ago
JSON representation

A service to deliver basic function about the file system

• Host: GitHub
• URL: https://github.com/forticheprod/quiet-stroll
• Owner: forticheprod
• License: mit
• Created: 2023-01-07T09:55:14.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-03-08T19:11:21.000Z (10 months ago)
• Last Synced: 2024-11-14T13:41:07.219Z (about 1 month ago)
• Topics: glob, openapi, rocket, rust, service, walk
• Language: Rust
• Homepage:
• Size: 76.2 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# quiet-stroll

## Decription

This repository is intend to create a POC of using rust to deliver client/server FS tools to:

- **walk**, crawl the file system from an entrypoint in the file tree

- **listdir**, simply list the files in a directory

- **glob**, use glob

## Under the hood

- walk is perform by [jwalk](https://github.com/Byron/jwalk)

- REST server is perform by [rocket](https://rocket.rs)

- glob is perform by [glob](https://docs.rs/glob/latest/glob/)

## Installation

`cargo install quiet-stroll`

## Usage

Quiet Stroll is based under [rocket](https://rocket.rs) framework

### Testing

#### Hello World

By default you will see `Hello, world!` by visiting .

#### Coffee: HTCPCP

You can test error code with the [Hyper Text Coffee Pot Control Protocol](https://en.wikipedia.org/wiki/Hyper_Text_Coffee_Pot_Control_Protocol)

by visiting  and not `coffe`

## Documentation

You can see the swagger documentation by visiting 

## License

Quiet Stroll is licensed under MIT License (LICENSE-MIT or )