README-en.md

Learn Braille

日本語版 README はこちら

This is Translate Braille, which is a web application for automatically translating Braille.

Table of Contents

• About
• Usage
• Development
  • Requirements
  • Recommended
  • Installation
  • Local Development
  • Before Commit
• Contributing

About

This is Translate Braille, which is a web application for automatically translating Braille.

Usage

To use this web application, just visit here.

Development

Requirements

• npm
• Python 3

Recommended

• VS Code Extensions
  • Prettier
  • Black

Installation

After cloning this repository, move to the project root directory and then run the command below.

npm run setup

Local Development

To start local development, run the command below. Then, you can access the application at http://localhost:5173/.

npm run dev

Before Commit

Before committing, run the command below to check the code style and types.

npm run format && npm run type-check

Contributing

Issue or PR is always welcome.