Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zheng-bote/rust_app-serv_photo-gallery
Rust Rocket application server for a web-based photo-gallery
https://github.com/zheng-bote/rust_app-serv_photo-gallery
rocket rust
Last synced: 21 days ago
JSON representation
Rust Rocket application server for a web-based photo-gallery
- Host: GitHub
- URL: https://github.com/zheng-bote/rust_app-serv_photo-gallery
- Owner: Zheng-Bote
- License: mit
- Created: 2024-10-04T08:39:39.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-10-04T13:44:05.000Z (3 months ago)
- Last Synced: 2024-12-01T09:28:35.922Z (22 days ago)
- Topics: rocket, rust
- Homepage: https://zheng-bote.github.io/rust_app-serv_photo-gallery/
- Size: 587 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
app-serv_photo-gallery
Rust Rocket application server for photo-gallery
[Report Issue](https://github.com/Zheng-Bote/rust_app-serv_photo-gallery/issues) [Request Feature](https://github.com/Zheng-Bote/rust_app-serv_photo-gallery/pulls)
[](https://choosealicense.com/licenses/mit/)
**Table of Contents**
- [Description](#description)
- [Features](#features)
- [Status](#status)
- [Application / Tool](#application--tool)
- [Documentation](#documentation)
- [README](#readme)
- [other Markdown files](#other-markdown-files)
- [Installation](#installation)
- [Dependencies](#dependencies)
- [folder structure](#folder-structure)
- [Usage/Examples/Tests](#usageexamplestests)
- [API Reference](#api-reference)
- [Inputs](#inputs)
- [Outputs](#outputs)
- [Parameters](#parameters)
- [Documentation](#documentation-1)
- [Architecture](#architecture)
- [Github](#github)
- [Github Repo](#github-repo)
- [Github Actions / Workflows](#github-actions--workflows)
- [Application](#application)
- [DevOps](#devops)
- [Github Page](#github-page)
- [Github Wiki](#github-wiki)
- [Comments](#comments)
- [Screenshots](#screenshots)
- [Authors and License](#authors-and-license)
- [License](#license)
- [Authors](#authors)
- [Code Contributors](#code-contributors)
# Description
Rust Rocket application server for a web-based photo-gallery.
### Features
- \[ ] advanced-super-extra-special feature xyz
- \[x] OSS and license
- \[x] works as designed
- \[ ] no bugs
- \[x] some more or less usefull Github Actions for GH-repo, GH-pages, GH-wiki, CI/CD-Pipelines
- \[ ] Packagemanager
- \[ ] Installation routine
- \[ ] portable application
- \[ ] runs on DOS/Windows
- \[ ] runs on MacOS
- \[ ] runs on Linux
- \[ ] runs on iOS
- \[ ] runs on Android
- \[ ] runs on HarmonyOS
## Status
### Application / Tool
### Documentation
_see also:_ [Application Documentation](#documentation)
#### README
[](https://github.com/Zheng-Bote/rust_app-serv_photo-gallery/actions/workflows/repo-create_tree_readme.yml)
[](https://github.com/Zheng-Bote/rust_app-serv_photo-gallery/actions/workflows/repo-actions_docu.yml)
[](https://github.com/Zheng-Bote/rust_app-serv_photo-gallery/actions/workflows/repo-call_Readme.yml)
#### other Markdown files
[](https://github.com/Zheng-Bote/rust_app-serv_photo-gallery/actions/workflows/repo-create_doctoc_md.yml)
create ToC in Markdown files in folders
- .github/actions/\*\*
- .github/workflows/\*\*
- dist/\*\*
- docs/\*\*
# Installation
bla bla ... everything easy and green with No Code/Low code and without any costs
## Dependencies
bla bla ... with a little help from my friends
## folder structure
```
.
├── .github
│ ├── actions
│ │ └── doctoc
│ │ ├── README.md
│ │ ├── action.yml
│ │ └── dist
│ │ ├── index.js
│ │ ├── index.js.map
│ │ ├── licenses.txt
│ │ └── sourcemap-register.js
│ └── workflows
│ ├── ghp-call_Readme.yml
│ ├── ghp-create_doctoc.yml
│ ├── ghp-markdown_index.yml
│ ├── repo-actions_docu.yml
│ ├── repo-call_Readme.yml
│ ├── repo-create_doctoc.yml_
│ ├── repo-create_doctoc_md.yml
│ └── repo-create_tree_readme.yml
├── LICENSE
├── README.md
└── tree.bak
5 directories, 17 files
```
## Usage/Examples/Tests
bla bla ... usage is intuitive and runs mostly automatically with no needs of any knowledge
```HTML
under construction
```
# API Reference
_Inputs/Outputs will be filled automatically by `.github/workflows/repo-actions_docu.yml`_
## Inputs
## Outputs
## Parameters
**Workflow or program**
| Parameter | Type | Description |
| :----------- | :------- | :----------------------------------- |
| `name` | `string` | _Optional_ name-of-copyright-holder |
| `created` | `string` | _Optional_ |
| `version` | `string` | _Optional_ \ |
| `link_left` | `string` | _Optional_ link-to-contact-page |
| `link_right` | `string` | _Optional_ link-to-legal-notice-page |
# Documentation
see also:
## Architecture
### Github
#### Github Repo
```mermaid
block-beta
columns 4
Repo:4
block:group1:1
columns 1
id0[".github"]
block:group2:1
columns 1
id1[["workflows"]]
id2[["actions"]]
end
end
docs dist src
block:group3:4
%% columns auto (default)
A["gh-pages"] B["gh-wiki"]
end
```
#### Github Actions / Workflows
```mermaid
flowchart TD;
A[Workflow]-. parameter .->B[[callable Workflow]]
B-- parameter -->C[Action]
C-->D(README)
A[Workflow]-. parameter .->E[[callable Workflow]]
E-- parameter -->F[Action]
F-->J(Markdown files)
A[Workflow]-->K[[Workflow]]
K-->L[Action]
L-->M("GH-Pages")
A[Workflow]-->N[[Workflow]]
N-->O[Action]
O-->P("GH-Wiki")
```
## Application
```mermaid
architecture-beta
group api(cloud)[API]
service db(database)[Database] in api
service server0(server)[Webserver] in api
service disk2(disk)[Storage] in api
service server(server)[Appserver] in api
db:L -- R:server
server0:T -- B:server
disk2:T -- B:server
```
## DevOps
```mermaid
pie title me
"ideas" : 90
"time for realizations" : 7
"money for realizations" : 3
```
## Github Page
[](https://www.github.com/Zheng-Bote)
## Github Wiki
[](https://www.github.com/Zheng-Bote)
## Comments
> \[!NOTE]
> Useful information that users should know, even when skimming content.
> \[!TIP]
> Helpful advice for doing things better or more easily.
> \[!IMPORTANT]
> Key information users need to know to achieve their goal.
> \[!WARNING]
> Urgent info that needs immediate user attention to avoid problems.
> \[!CAUTION]
> Advises about risks or negative outcomes of certain actions.
## Screenshots
# Authors and License
## License
[](https://choosealicense.com/licenses/mit/)
Copyright (c) 2024 ZHENG Robert
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
https://choosealicense.com/licenses/mit/
## Authors
- [](https://www.github.com/Zheng-Bote)
### Code Contributors
[](https://www.github.com/Zheng-Bote)
:vulcan_salute: