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

README: update

Browse source
This commit is contained in:
0x1eef 2024-03-11 14:45:11 -03:00
parent e871c5309a
commit 2350a8d56e
4 changed files with 13 additions and 21 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
README.md
View file

@ -1,7 +1,8 @@
## About ## About
Twenty helps you manage your projects with a web application Twenty helps you manage and plan your open source projects with a
that runs on your computer. standalone web application that's designed to run on localhost or
within your local network. It is both easy to use, and easy to install.
## Features ## Features
@ -14,25 +15,24 @@ that runs on your computer.
## Design ## Design
* The server is powered by [ruby/webrick](https://github.com/ruby/webrick): * The server is powered by [ruby/webrick](https://github.com/ruby/webrick):
* Accepts GraphQL requests at `/graphql`. - Accepts GraphQL requests at `/graphql`.
* Serves client (HTML, JS, CSS). - Serves client (HTML, JS, CSS).
* Dependencies: ActiveRecord, SQLite3, ruby-graphql. - Dependencies: ActiveRecord, SQLite3, ruby-graphql.
* The client is a statically compiled [nanoc](https://github.com/nanoc/nanoc) website: * The client is a statically compiled [nanoc](https://github.com/nanoc/nanoc) website:
* Dependencies: webpack, typescript, react. - Dependencies: webpack, typescript, react.
* The CLI controls the web server: * The CLI controls the web server:
* Start / stop web server. - Start / stop web server.
* Run database migrations. - Run database migrations.
* Run developer console. - Run developer console.
* Each component (server, client, cli) are separate packages * Each component (server, client, cli) are separate packages
in a monorepo. in a monorepo.
* Easy to distribute as a RubyGem. * Easy to distribute as a RubyGem.
## Usage ## Usage
The CLI is available as two identical executables: <br> **CLI**
`$ 20`, and `$ twenty`.
Usage: 20 COMMAND [OPTIONS] Usage: twenty COMMAND [OPTIONS]
Commands: Commands:
up Start the twenty web server. up Start the twenty web server.
@ -42,10 +42,6 @@ The CLI is available as two identical executables: <br>
migrate Migrate the database. migrate Migrate the database.
console Start the twenty developer console. console Start the twenty developer console.
## Screenshots
![img](./share/twenty/demo.png)
## Install ## Install
$ gem install twenty.rb $ gem install twenty.rb

BIN
share/twenty/demo.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 62 KiB

4
twenty-cli/bin/20
View file

@ -1,4 +0,0 @@
#!/usr/bin/env ruby
# frozen_string_literal: true
Process.wait spawn([File.join(__dir__, "twenty"), "20"], *ARGV)

2
twenty-cli/bin/twenty
View file

@ -24,7 +24,7 @@ when "console"
wait spawn("console", *ARGV[1..]) wait spawn("console", *ARGV[1..])
exit $?.exitstatus exit $?.exitstatus
else else
warn "Usage: 20 COMMAND [OPTIONS]\n\n" \ warn "Usage: twenty COMMAND [OPTIONS]\n\n" \
"Commands:\n" \ "Commands:\n" \
" up Start the twenty web server.\n" \ " up Start the twenty web server.\n" \
" down Stop the twenty web server.\n" \ " down Stop the twenty web server.\n" \