From 7bfc40db67f2d3ec18d7e722856f99fa9eca1ed6 Mon Sep 17 00:00:00 2001 From: TheoryOfNekomata Date: Tue, 12 Mar 2024 19:43:28 +0800 Subject: [PATCH] Add documentation Include README and FAQs. --- README.md | 7 +++++++ docs/01-faqs.md | 25 +++++++++++++++++++++++++ 2 files changed, 32 insertions(+) create mode 100644 README.md create mode 100644 docs/01-faqs.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..8fea3bd --- /dev/null +++ b/README.md @@ -0,0 +1,7 @@ +# `yasumi` + +**HATEOAS-first backend framework** + +This is a proposed solution to most Web frameworks that will hopefully inspire other solutions. + +See [docs folder](./docs) for more details. diff --git a/docs/01-faqs.md b/docs/01-faqs.md new file mode 100644 index 0000000..d1576d4 --- /dev/null +++ b/docs/01-faqs.md @@ -0,0 +1,25 @@ +# Frequently Asked Questions + +> Why another (JavaScript) framework? + +Yes. + +> No, but seriously? Why JavaScript? + +I find it comfortable to create stuff in TypeScript. However, the reader must pay attention to the underlying architecture instead of the specifics of the platform being implemented on. + +> Then why another framework? + +Most frameworks focus on the routing and the logic side of things. This is reasonable for most applications. However, the benefits of hypermedia becomes an afterthought, wherein attempts to produce rich structured data become ignored (as compliance with Web standards is not a requirement for building Web services, however developers comply with some aspects of REST in order to create some rudimentary RPC service). + +> What's the point then? + +The goal of the framework is to empower developers on focusing on the business logic while not being hindered by considering proper REST (and ultimately HATEOAS) guidelines on the resulting implementation. + +> What is the expected output of this project? + +The choices include implementing a plugin to complement popular frameworks, as well as an entirely new framework with adapters to various common components of Web services (such as persistent storage). + +> What's the timeline for this project? + +Indefinite. However I shall provide milestones if necessary for certain periods of time.