ut-code / dot-tutor

Learn Braille, which is a web application for learning Braille
https://learn.dot-tutor.com/
MIT License
4 stars 0 forks source link

Dot Tutor

CI Deploy Staging Deploy Production license PRs

こちらは、Dot Tutorのリポジトリです。

目次

概要

こちらは、Dot Tutorのリポジトリです。ウェブサイトと、Dot Tutor Learn、Dot Tutor Translateの3つのアプリケーションを含んでいます。

使い方

ウェブサイトは、https://dot-tutor.com/にアクセスしてください。 Dot Tutor Learnは、https://learn.dot-tutor.com/にアクセスしてください。 Dot Tutor Translateは、https://translate.dot-tutor.com/にアクセスしてください。

開発

要件

推奨

環境構築

このリポジトリをクローンしてから、プロジェクトのルートディレクトリに移動し、以下のコマンドを実行してください。

npm setup

開発用サーバーの起動

ウェブサイト

開発用サーバーを起動するには、以下のコマンドを実行してください。そうすると、http://localhost:3000でアプリケーションにアクセスできます。

npm run dev:website

Dot Tutor Learn

開発用サーバーを起動するには、以下のコマンドを実行してください。そうすると、http://localhost:3000でアプリケーションにアクセスできます。

npm run dev:learn

Dot Tutor Translate

バックエンドの起動は、こちらを参照してください。

フロントエンドの開発用サーバーを起動するには、以下のコマンドを実行してください。そうすると、http://localhost:3000でアプリケーションにアクセスできます。

npm run dev:translate

コミット前

コミット前には、プロジェクトルートで以下のコマンドを実行して、コードスタイルと型のチェックを行ってください。

npm run lint && npm run type-check

ライセンス

このソフトウェアは MIT ライセンスのもとで公開されています。

Copyright © 2023 ut.code();.

コントリビューション

Issue や PR などはいつでも歓迎します。