Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
zenlex authored Feb 25, 2024
1 parent 3f8e9bc commit fc6598d
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,22 +4,29 @@ A simple configurable API gateway for linking microservices to the Tulsa Web Dev
Built in Rust and containerized with Docker.

## CONTRIBUTING
This is mostly a labor of love and learning that we might actually use. There are certainly existing solutions to this problem in the wild already. I'm building this in Rust🦀 to get better at my skills in that language and what I percieve as some of its strengths. I hope to learn more about performance optimization, telemetry/observability, and security. I'm happy to have friends on this journey who are in the mood to hack on it with me, just send me a message / make a draft PR if you have questions. I'm not going to write a lengthy contributing doc for this(yet)😅.
This is mostly a labor of love and learning that we might actually use. There are certainly existing solutions to this problem in the wild already.

I'm building this in Rust🦀 to get better at my skills in that language and what I percieve as some of its strengths. I hope to learn more about performance optimization, telemetry/observability, and security.

I'm happy to have friends on this journey who are in the mood to hack on it with me, just send me a message / make a draft PR if you have questions. I'm not going to write a lengthy contributing doc for this(yet)😅.

## ROADMAP
### MVP 0.x
- [ ] Define API
- [ ] Containerize for development
- [ ] Build Config mechanism
- [ ] Build Simple Routing mechanism (JWT auth from front end, all just passed username / basic user metadata from Clerk.io, contents TBD)

*as time allows, build the Clerk interface to back pair of auth and metadata services so that the auth/metadata service is configurable*

- [ ] Containerize for deployment
- [ ] Test
- [ ] Deploy

### Future Development
#### High Priority
- [ ] Add reverse proxy
- [ ] Add observability mechanisms (OpenTelemtry/tracing.rs ?)
- [ ] Add auth bypass option for public APIs to config (Auth on by default)
- [ ] Add read/write options to user metadata per service (nested under service name)

Expand Down

0 comments on commit fc6598d

Please sign in to comment.