From d5ff309c5baa3b284969e7b4123913c2ca2628a3 Mon Sep 17 00:00:00 2001 From: Takamichi Omori Date: Sun, 16 Feb 2020 20:09:42 +0900 Subject: [PATCH 1/2] initial commit --- README.md | 32 ++++++++++++++++++++++++++++++++ README_ja.md | 36 ++++++++++++++++++++++++++++++++++++ 2 files changed, 68 insertions(+) create mode 100644 README.md create mode 100644 README_ja.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..ee49d5d --- /dev/null +++ b/README.md @@ -0,0 +1,32 @@ +# Trinity +Usefull framework to operating Web Applications for beginners. + +## What's this? +This Application is framework to solve trouble in operating Web services. + +Individual developers doesn't have +- Money +- Time +- manpower + +Trinity has +- Logging +- Notification using Webhook +- Continuous Delivery with GitHub + +Trinity reduce your workload. + +## Getting Started + +Download from [GitHub - Releases](). + +or clone this repository and build yourself. + + +### Prerequisites +You need +- Node.js (above v12.4) +- Go (above v1.11 ) + - [rakyll/tatik](https://github.com/rakyll/statik) + + diff --git a/README_ja.md b/README_ja.md new file mode 100644 index 0000000..12d767a --- /dev/null +++ b/README_ja.md @@ -0,0 +1,36 @@ +# Trinity +個人開発者向けWebサービス運用フレームワーク + +## What's this? +Webサービス運用時にある悩みを解決するためのフレームワークです。 +個人開発者は、 +- お金 +- 時間 +- 人手 +がありません。 + +Trinityは +- ログ収集 +- WebHookを用いた通知 +- GitHubからのCD機能 + +を搭載しており、個人開発者の負荷を減らします。 + + +## Getting Started +ダウンロードして使ってみたい場合、[GitHub - Releases]()からダウンロードしてください。 + +### Prerequisites +ローカルでビルドする場合 +- Node.js (v12.4以上) +- Go (v1.11以上) + - [rakyll/tatik](https://github.com/rakyll/statik) +が必要です。 + +ビルドは`make`で完結します。 +``` +> make +``` + + From 6ceaf4b5a4bb8dec550751257368ed59f17f9514 Mon Sep 17 00:00:00 2001 From: Takamichi Omori Date: Sun, 16 Feb 2020 20:52:47 +0900 Subject: [PATCH 2/2] update readme --- README.md | 78 +++++++++++++++++++++++++++++++++++++++++++++----- README_ja.md | 80 +++++++++++++++++++++++++++++++++++++++++++++++++--- 2 files changed, 147 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index ee49d5d..1e75afa 100644 --- a/README.md +++ b/README.md @@ -16,17 +16,81 @@ Trinity has Trinity reduce your workload. -## Getting Started +### Prerequisites +You need to Build trinity +- Node.js (above v12.4) +- Go (above v1.11 ) + - [rakyll/tatik](https://github.com/rakyll/statik) -Download from [GitHub - Releases](). -or clone this repository and build yourself. +## Requirements and Setup +You can try Trinity by downloading from [GitHub - Releases](). +Or You can build yourself. +### Cloning the Repo +Before you start working on Trinity, you'll need to clone our GitHub repository: -### Prerequisites -You need +```sh +git clone git@github.com:sechack-z/trinity +``` + +Now, enter the repository. + +```sh +cd trinity +``` +### Build as single binary +We want to make easy to use Trinity. +So Trinity can build as single binary. +#### Install Dependencies. - Node.js (above v12.4) -- Go (above v1.11 ) - - [rakyll/tatik](https://github.com/rakyll/statik) +- Go (above v1.11) +- [rakyll/tatik](https://github.com/rakyll/statik) +- make + +or server and client can be built separately. + +### Client +Client works in `client` directory. +``` +cd client +``` +#### Node.js +Client is written by [Node.js](https://nodejs.org/en/). +You'll need to install `Node.js` for your system to build client. + +**Note**: This is confirmed to work on `Node.js v12.4`, but there may be issues on other versions. If you have trouble, please bump your Node.js version to 12.4. +#### Installing Dependencies +We're using a package manager called Yarn. You'll need to install Yarn before continuing. + + +Install all required packages with: + +```sh +yarn +``` + +#### Building Client +Build client: + +```sh +yarn build:stage +``` + + +### Server +Server works in `server` directry. +#### Go +Server is written by [Go](https://golang.org). +You'll need to install `Go` for your system to build server. + +**Note**: This is confirmed to work on `Go v1.11`, but there may be issues on other versions. If you have trouble, please bump your Go version to 1.11. +#### Installing Dependencies +This project is using `Go modules`. +So dependencies is automatically download when you build server. +#### Building Server +```sh +go build +``` diff --git a/README_ja.md b/README_ja.md index 12d767a..fce8029 100644 --- a/README_ja.md +++ b/README_ja.md @@ -17,8 +17,6 @@ Trinityは を搭載しており、個人開発者の負荷を減らします。 -## Getting Started -ダウンロードして使ってみたい場合、[GitHub - Releases]()からダウンロードしてください。 ### Prerequisites ローカルでビルドする場合 @@ -32,5 +30,79 @@ Trinityは > make ``` - +## Requirements and Setup +[GitHub - Releases]()からダウンロードして試すことができます。 + +もしくは、手元でのビルドを試してください。 + +### Cloning the Repo +まずこのリポジトリをクローンしてください。 + +```sh +git clone git@github.com:sechack-z/trinity +``` + +ディレクトリに移動してください。 +```sh +cd trinity +``` + +### Build as single binary +Trinityをかんたんに動かすために、シングルバイナリでのビルドをできるようにしました。 + +#### Install Dependencies. +- Node.js (above v12.4) +- Go (above v1.11) +- [rakyll/tatik](https://github.com/rakyll/statik) + - シングルバイナリ化に使用 +- make + +リポジトリのルートで`make`コマンドを使用してください。 +```sh +make build +``` +もしくは、serverとclientそれぞれをビルドすることができます +### Client +Clientは`client`ディレクトリに格納されています。 +``` +cd client +``` +#### Node.js +Clientは[Node.js](https://nodejs.org/en/)で書かれています。 +ビルドのために、`Node.js`をインストールしてください。 +**Note**: `Node.js v12.4`で検証されていますが、いくつか問題があるかもしれません。何か問題が発生した場合、`v12.4`へのアップデートを検討してください。 + + +#### Installing Dependencies +Yarnと呼ばれるパッケージマネージャを使用しています。 +続けるにはYarnをインストールしてください。 + +依存パッケージをインストールしてください。 +```sh +yarn +``` + +#### Building Client +Clientをビルドします。 +```sh +yarn build:stage +``` + + +### Server +Serverは`server`ディレクトリに格納されています。 +#### Go +Serverは[Go](https://golang.org)で書かれています。 +ビルドのために、`Go`をインストールしてください。 +**Note**: `Go v1.11`で検証されていますが、いくつか問題があるかもしれません。何か問題が発生した場合、`v1.11`へのアップデートを検討してください。 + + +#### Installing Dependencies +`Go modules`を使用しています。 +そのため、ビルド時に依存パッケージは自動的にダウンロードされます。 + +#### Building Server +```sh +go build +``` +