はまったいまー

はまったいまーは、ハマった時に時間を浪費してしまう問題を解決したいプログラミング学習者のための、タイマー付きメモアプリです。

主な機能

タイマー

はじめにタイマーをセットしておき、その時間になるとお知らせします。

時間を区切って取り組むことで、詰まってしまった時は人に質問してみるなど次の手を打ちやすくなります。

メモ

入力フォームを埋める形で、問題解決のために何を考えて何をやったのか、記録を作ることができます。

エラー対応中は慌ててしまったり視野が狭くなったりしがちですが、書くことで自分を客観視しやすくなります。また、後日同じような事象が起こった時に、前回はどうしたのか調べる際にも役立ちます。

入力中のメモは画面右側にリアルタイムでプレビューが表示されます。

メモのエクスポート

入力したメモを保存する方法を2種類用意しています。

• MarkdownファイルとしてGistに保存
• Markdown形式でクリップボードにコピー

使用技術

フレームワーク

• Next.js + Vercel

テスト

• ユニットテスト
  • Jest + React Testing Library
• E2Eテスト
  • Playwright

外部サービス連携

• GitHub OAuth Apps / GitHub REST API
• Cloudinary API

開発環境の構築手順

1. リポジトリのClone

   $ git clone https://github.com/yocaji/hamattimer.git
   

2. 環境変数の設定 .env.local.templateを参考に.env.localを作成してください
   • 事前に以下を行い、Client secret等の必要な情報を取得する必要があります
     • GitHub OAuth Appの作成
     • CloudinaryのUpload API利用設定
3. 依存パッケージインストール

   $ yarn install
   

4. 開発サーバー起動

   $ yarn dev
   

Lint & Tests

• Lint

  $ yarn lint
  

• Run tests

  $ yarn test