Skip to content

Commit eff27ea

Browse files
committed
docs(readme): add features and screenshots
1 parent 55a2e8a commit eff27ea

4 files changed

Lines changed: 28 additions & 0 deletions

File tree

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,33 @@
11
# EvOps / Back End
22

3+
Main repository: https://github.com/evops-sum25/evops
4+
5+
## Features
6+
7+
- API methods to create and view users, events, event images, and event tags
8+
(groups).
9+
- Combined REST+gRPC web-server so that clients can choose their preferred
10+
communication way.
11+
- Auto-generated OpenAPI documentation + Swagger webpage.
12+
- Persistent data storage with PostgreSQL.
13+
- Persistent image storage with MinIO.
14+
- Data validation at the type-system level.
15+
- Basic logging of incoming requests and their responses.
16+
- Configurability with environment variables and a [`.env`](/.env.example) file.
17+
- An [API extension](https://github.com/evops-sum25/evops-client-ext) for
18+
clients to ease the interaction with our back end:
19+
- Validation functions (such as `validate_event_title` or
20+
`validate_tag_alias`) that reuse the logic from the back-end core.
21+
- Fully-typed Markdown parser with our own parse settings.
22+
- Exporting to WASM with Extism and Protobuf types.
23+
- Generating type-safe FFI bindings with UniFFI.
24+
25+
## Screenshots
26+
27+
<img src="/assets/swagger-1.jpg" width=480 />
28+
<img src="/assets/swagger-2.jpg" width=480 />
29+
<img src="/assets/grpcui.jpg" width=480 />
30+
331
## Build Instructions
432

533
1. Create a [`.env`](`/.env.example`).

assets/grpcui.jpg

128 KB
Loading

assets/swagger-1.jpg

215 KB
Loading

assets/swagger-2.jpg

140 KB
Loading

0 commit comments

Comments
 (0)