No description
Find a file
2024-04-26 21:03:28 -03:00
.bundle Add .bundle/config 2023-12-20 11:24:54 -03:00
cli v0.5.2 2024-04-26 21:03:28 -03:00
client v0.5.2 2024-04-26 21:03:28 -03:00
host Regen schema.ts, schema.graphql 2024-04-25 18:49:23 -03:00
server v0.5.2 2024-04-26 21:03:28 -03:00
.gitignore Add tooling for gem releases 2024-02-07 19:40:48 -03:00
.gitmodules Drop 'twenty-' prefix from toplevel directories 2024-04-21 20:11:25 -03:00
.projectile Combine multiple entry points into one 2024-04-25 03:40:55 -03:00
.rubocop.yml Extend scope of 'rubocop:apply' 2024-04-25 04:16:57 -03:00
Gemfile Drop 'twenty-' prefix from toplevel directories 2024-04-21 20:11:25 -03:00
LICENSE Add twenty-frontend/ 2023-12-08 15:27:00 -03:00
Rakefile.rb Move "host" files to host/ 2024-04-21 22:13:01 -03:00
README.md Fix README 2024-04-26 14:08:38 -03:00
twenty.gemspec v0.5.2 2024-04-26 21:03:28 -03:00
twenty.gemspec.tt Rename: *.gemspec.erb => *.gemspec.tt 2024-04-21 22:54:47 -03:00
VERSION v0.5.2 2024-04-26 21:03:28 -03:00

About

Twenty helps you plan your open source projects with a standalone web application that's designed to run on localhost or within your local network.

Features

  • Provides a command-line utility to start / stop a web server
  • Connect / disconnect a project from the command line
  • Designed to work offline
  • Lightweight stack
  • Easy to install, easy to use

Design

  • The server is powered by rack and puma:
    • Accepts GraphQL requests at /graphql
    • Serves client (HTML, JS, CSS)
    • Dependencies: Sequel, SQLite3, ruby-graphql
  • The client is a statically compiled 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

CLI

Usage: twenty COMMAND [OPTIONS]

Commands:
  up             Start the twenty web server
  down           Stop the twenty web server
  connect        Connect a project to twenty
  disconnect     Disconnect a project from twenty
  migrate        Migrate the database
  console        Start the twenty developer console

Install

Twenty is distributed as a RubyGem:

$ gem install twenty

Sources

License

BSD Zero Clause.
See LICENSE