TODO: Start CodeSpace Badge https://github.com/codespaces/new?repo=cloudless-hq%2Fatreyu
attention: This is early pre-release software. Things will still be missing, break or change without warning. If you want to try the preview, please consider reaching out with a short description of your usecase to try.ayu@ntr.io, i am happy to give you feedback if the usecase is already feasible and help you setup.
Atreyu is an edge- and serviceworker first metaframework for personal, data centric web applications. It supports real time data sync, offline usage and values minimal boilerplate with opt in to most features.
Falcor is used for state management, caching, batching and data sharing. Svelte views are bound to a virtual data object with a js proxy based store implementation. The falcor router runs inside a service worker and can serve all open tabs and transparently only forward requests to the edge workers or other sources when it cannot answer itself or needs to refresh data.
With this focus we can exclude a few features of mainstream frameworks that add complexity and have little to negative effect and add features that are usually missing:
Dependencies needed:
Then install with:
deno run --reload https://atreyu.dev/ayu@latest/cli/install.js
You will see 3 prompts, 2 to check DENO_HOME and HOME environmnet variables, to determine where to install and the final write access to install the cli.
After that you will have the ayu command available. just run ayu --help
for an overview of the options.
The first time you use atreyu, it will initialize the atreyu repo, defaulting to ~/.atreyu
. This is used as the content adressable asset store and for configuration.
To create a new project or getting an example application, use the create command.
ayu create my-ayu-app && cd my-ayu-app
You can start a standard dev server in the current folder by running ayu
For detailed documentation please have a look at https://atreyu.dev
For documentation for working on atreyu itself see CONTRIBUTING.md