No description
Find a file
2024-03-12 05:11:38 -03:00
.bundle Add .bundle/config 2023-12-20 11:24:54 -03:00
bin Update bin/setup 2024-02-18 01:15:22 -03:00
lib Fix require in lib/twenty.rb 2024-02-16 03:20:42 -03:00
rakelib Rename 'frontend' as 'client', 'backend' as 'server' 2024-02-15 22:23:10 -03:00
twenty-cli Update cmd.rb to v0.5.0 2024-03-11 15:03:04 -03:00
twenty-client Fix stale references to twenty-backend 2024-02-17 20:41:35 -03:00
twenty-server Update Path 2024-03-12 04:57:14 -03:00
.gitignore Add tooling for gem releases 2024-02-07 19:40:48 -03:00
.projectile Update .projectile 2024-02-09 19:57:53 -03:00
Gemfile Rename 'frontend' as 'client', 'backend' as 'server' 2024-02-15 22:23:10 -03:00
LICENSE Add twenty-frontend/ 2023-12-08 15:27:00 -03:00
Rakefile.rb Rename 'frontend' as 'client', 'backend' as 'server' 2024-02-15 22:23:10 -03:00
README.md README: update 2024-03-12 05:11:38 -03:00
twenty.rb.gemspec Rename 'frontend' as 'client', 'backend' as 'server' 2024-02-15 22:23:10 -03:00
twenty.rb.gemspec.erb Rename 'frontend' as 'client', 'backend' as 'server' 2024-02-15 22:23:10 -03:00
VERSION v0.3.5 2024-02-15 21:46:26 -03:00

About

Twenty helps you manage and plan your open source projects with a 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

  • Provides a command-line utility to start / stop a web server.
  • Connect / disconnect a project from the command line.
  • Works offline. Binds to http://localhost:2020 by default.
  • Minimal: Ruby, and SQLite3 are the primary runtime dependencies.
  • Easy to install, easy to use.

Design

  • The server is powered by ruby/webrick:
    • Accepts GraphQL requests at /graphql.
    • Serves client (HTML, JS, CSS).
    • Dependencies: ActiveRecord, 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.rb

Sources

License

BSD Zero Clause.
See LICENSE