/Tsundoku

Progressive Web App for people having lots of unread tech books

Primary LanguageTypeScriptMIT LicenseMIT

Tsundoku.tech

Packagist Build Status Maintainability

効率的に技術書を読もう。賢く積読しよう。

  • フロントエンドは Ionic 3 (Angular 6, RxJS v6) / AngularFire を用いて実装する
  • フロントエンドの静的ファイルは Netlify でホスティングする
  • Cloud Functions / Cloud Firestore を用いてサーバーサイドを構築する
  • Firebase Authentication を用いてアカウント管理を行う

ローカル開発環境の構築

まず、 yarn をインストールして下さい。

その後、以下のコマンドを実行して Firebase CLI の初期設定を行って下さい。

$ yarn global add firebase-tools
$ firebase login
# Google アカウントでログインして下さい

最後に、以下のコマンドを実行して Tsundoku のソースコードの取得と依存パッケージのインストールを行って下さい。
ionic-app ディレクトリと functions ディレクトリは分離された npm プロジェクトです。
shared ディレクトリ内の .ts 形式のソースファイルは、この 2 つの npm プロジェクトで共有されます。

$ git clone https://github.com/TsundokuApp/Tsundoku
$ cd Tsundoku/ionic-app
$ yarn install
$ cd ../functions
$ yarn install

細かな仕様や DB の設計などについては、Reference リポジトリを参照して下さい。