webskel/dolphins7.skeleton
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

README: add 'Design' section

Browse source
This commit is contained in:
0x1eef 2024-01-14 18:48:27 -03:00
parent 5f64b8a5ff
commit 7a6e6f368f
1 changed files with 16 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -11,6 +11,22 @@ that runs on your computer with a minimal amount of effort.
* Minimal: Ruby, and SQLite3 are the primary runtime dependencies.
* Easy to install, easy to use.
## Design
* The server is powered by [ruby/webrick](https://github.com/ruby/webrick):
* Accepts GraphQL requests at `/graphql`.
* Serves client (HTML, JS, CSS).
* Dependencies: ActiveRecord, SQLite3, ruby-graphql.
* The client is a statically compiled [nanoc](https://github.com/nanoc/nanoc) website:
* Dependencies: webpack, typescript, react.
* The CLI controls the web server:
* Start / stop web server.
* Run database migrations.
* Run developer console.
* Each component (server, client, cli) are separate packages
in a monorepo.
* Easy to distribute as a RubyGem.
## Usage
Usage: twenty COMMAND [OPTIONS]