60 lines
1.6 KiB
Markdown
60 lines
1.6 KiB
Markdown
## 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](https://github.com/rack/rack) and [puma](https://github.com/puma/puma):
|
|
- Accepts GraphQL requests at `/graphql`
|
|
- Serves client (HTML, JS, CSS)
|
|
- Dependencies: Sequel, 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
|
|
|
|
**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
|
|
|
|
* [GitHub](https://github.com/0x1eef/twenty)
|
|
* [GitLab](https://gitlab.com/0x1eef/twenty)
|
|
|
|
## License
|
|
|
|
[BSD Zero Clause](https://choosealicense.com/licenses/0bsd/).
|
|
<br>
|
|
See [LICENSE](./LICENSE)
|