| Node.js 함수 | +Python 함수 | +설명 | +
|---|---|---|
| encode | +encode | +문자열을 바이너리로 변환합니다. | +
| translateToUnicode | +translate_to_unicode | +문자열을 유니코드 점자로 변환합니다. | +
| translateToBrailleFont | +translate_to_braille_font | +문자열을 점자 폰트로 변환합니다. | +
+## Python +
+```bash +pip install braillify # python +``` + +
+## Nodejs +
+```bash +npm install braillify # nodejs +``` \ No newline at end of file diff --git a/apps/landing/src/app/docs/layout.tsx b/apps/landing/src/app/docs/layout.tsx new file mode 100644 index 00000000..d6c9e15b --- /dev/null +++ b/apps/landing/src/app/docs/layout.tsx @@ -0,0 +1,28 @@ +import { Box, Flex } from '@devup-ui/react' + +import { LeftMenu } from './LeftMenu' +import { RightIndex } from './RightIndex' + +export default function DocsLayout({ + children, +}: Readonly<{ + children: React.ReactNode +}>) { + return ( +
+ +Braillify 는 완전 오픈소스 한글 점역 라이브러리입니다. +
+ +기존에도 한글 점역 라이브러리가 존재했으나 2024 개정 한국 점자 규정을 준수하지 않거나, 오픈소스가 아니었습니다. + +
+하지만 Braillify 가 Apache License 2.0 라이센스를 기반으로 완전 오픈소스 점자 라이브러리를 공개합니다. + +
+원하는 한글을 점역해보세요. + +
+Rust 기반으로 네이티브 성능을 구현했고, nodejs, python 등 가장 대중적인 언어들을 지원합니다. + +
+# 테스트 케이스 추가 +
+ +[github issue](https://github.com/dev-five-git/braillify/issues) 에서 테스트 케이스 추가를 건의해주세요. +
+ +지속적인 테스트 케이스 추가로 옛한글, 수학, 컴퓨터 점자까지 한글 점자 완전 정복을 위하여 함께 노력합시다. + +
+# 기여하기 +
+모든 오픈소스 기여는 환영입니다. \ No newline at end of file diff --git a/apps/landing/src/app/docs/theme/page.mdx b/apps/landing/src/app/docs/theme/page.mdx new file mode 100644 index 00000000..e67cab39 --- /dev/null +++ b/apps/landing/src/app/docs/theme/page.mdx @@ -0,0 +1,5 @@ +export const metadata = { + title: 'Theme', +} + +# Theme \ No newline at end of file diff --git a/apps/landing/src/app/globals.css b/apps/landing/src/app/globals.css new file mode 100644 index 00000000..f2a4a3ff --- /dev/null +++ b/apps/landing/src/app/globals.css @@ -0,0 +1,15 @@ +@import url(//spoqa.github.io/spoqa-han-sans/css/SpoqaHanSansNeo.css); + + +html, +body { + max-width: 100vw; + overflow-x: hidden; +} + + +* { + box-sizing: border-box; + padding: 0; + margin: 0; +} \ No newline at end of file diff --git a/apps/landing/src/app/layout.tsx b/apps/landing/src/app/layout.tsx new file mode 100644 index 00000000..db239924 --- /dev/null +++ b/apps/landing/src/app/layout.tsx @@ -0,0 +1,53 @@ +import './globals.css' + +import { Box, css, ThemeScript } from '@devup-ui/react' +import type { Metadata } from 'next' + +import Footer from '@/components/Footer' +import Header from '@/components/Header' + +export const metadata: Metadata = { + title: 'Braillify', + description: 'Braillify', +} + +export default function RootLayout({ + children, +}: Readonly<{ + children: React.ReactNode +}>) { + return ( + + +
한층 더 쉬운 점자화를 보다 널리 퍼뜨리고자 만든 + 프로젝트입니다. +
+ 모두가 점역을 이해하고 활용할 수 있는 환경을 함께 만들어갑니다. +
점자와 세상, 모두를 연결하는 여정을 시작해보세요. +
+ 정답 : {expected} +
+ 결과 : {actual} +
+ {isSuccess ? '✅ 테스트 성공' : '❌ 테스트 실패'} +
Copyright © 2021-2023 데브파이브. All Rights Reserved. +
+ {children}
+
+ )
+ },
+}
+
+export function useMDXComponents(components: MDXComponents): MDXComponents {
+ return {
+ ...components,
+ ..._components,
+ }
+}
diff --git a/apps/landing/tsconfig.json b/apps/landing/tsconfig.json
new file mode 100644
index 00000000..177f0bd9
--- /dev/null
+++ b/apps/landing/tsconfig.json
@@ -0,0 +1,41 @@
+{
+ "compilerOptions": {
+ "target": "ES2017",
+ "lib": [
+ "dom",
+ "dom.iterable",
+ "esnext"
+ ],
+ "allowJs": true,
+ "skipLibCheck": true,
+ "strict": true,
+ "noEmit": true,
+ "esModuleInterop": true,
+ "module": "esnext",
+ "moduleResolution": "bundler",
+ "resolveJsonModule": true,
+ "isolatedModules": true,
+ "jsx": "preserve",
+ "incremental": true,
+ "plugins": [
+ {
+ "name": "next"
+ }
+ ],
+ "paths": {
+ "@/*": [
+ "./src/*"
+ ]
+ }
+ },
+ "include": [
+ "next-env.d.ts",
+ "**/*.ts",
+ "**/*.tsx",
+ ".next/types/**/*.ts",
+ ".df/*.ts"
+ ],
+ "exclude": [
+ "node_modules"
+ ]
+}
\ No newline at end of file
diff --git a/eslint.config.mjs b/eslint.config.mjs
new file mode 100644
index 00000000..c9f97135
--- /dev/null
+++ b/eslint.config.mjs
@@ -0,0 +1,3 @@
+import { configs } from 'eslint-plugin-devup'
+
+export default configs.recommended
diff --git a/libs/korea/Cargo.toml b/libs/braillify/Cargo.toml
similarity index 80%
rename from libs/korea/Cargo.toml
rename to libs/braillify/Cargo.toml
index c1d05765..6436f9e5 100644
--- a/libs/korea/Cargo.toml
+++ b/libs/braillify/Cargo.toml
@@ -1,6 +1,6 @@
[package]
name = "braillify"
-version = "0.1.0"
+version = "1.0.0"
edition = "2024"
[dependencies]
@@ -9,3 +9,4 @@ phf = { version = "0.11", features = ["macros"] }
[dev-dependencies]
csv = "1.3.0"
+serde_json = "^1"
diff --git a/libs/korea/src/char_shortcut.rs b/libs/braillify/src/char_shortcut.rs
similarity index 100%
rename from libs/korea/src/char_shortcut.rs
rename to libs/braillify/src/char_shortcut.rs
diff --git a/libs/korea/src/char_struct.rs b/libs/braillify/src/char_struct.rs
similarity index 97%
rename from libs/korea/src/char_struct.rs
rename to libs/braillify/src/char_struct.rs
index dd9798af..84c1fbb7 100644
--- a/libs/korea/src/char_struct.rs
+++ b/libs/braillify/src/char_struct.rs
@@ -58,7 +58,7 @@ pub enum CharType {
Number(char),
Symbol(char),
MathSymbol(char),
- Space,
+ Space(char),
}
impl CharType {
@@ -86,7 +86,7 @@ impl CharType {
return Ok(Self::Korean(KoreanChar::new(c)?));
}
if c.is_whitespace() {
- return Ok(Self::Space);
+ return Ok(Self::Space(c));
}
Err("Invalid character".to_string())
}
@@ -108,6 +108,6 @@ mod test {
CharType::new('ㄱ').unwrap(),
CharType::KoreanPart('ㄱ')
));
- assert!(matches!(CharType::new(' ').unwrap(), CharType::Space));
+ assert!(matches!(CharType::new(' ').unwrap(), CharType::Space(' ')));
}
}
diff --git a/libs/korea/src/english.rs b/libs/braillify/src/english.rs
similarity index 100%
rename from libs/korea/src/english.rs
rename to libs/braillify/src/english.rs
diff --git a/libs/korea/src/jauem/choseong.rs b/libs/braillify/src/jauem/choseong.rs
similarity index 100%
rename from libs/korea/src/jauem/choseong.rs
rename to libs/braillify/src/jauem/choseong.rs
diff --git a/libs/korea/src/jauem/jongseong.rs b/libs/braillify/src/jauem/jongseong.rs
similarity index 100%
rename from libs/korea/src/jauem/jongseong.rs
rename to libs/braillify/src/jauem/jongseong.rs
diff --git a/libs/korea/src/jauem/mod.rs b/libs/braillify/src/jauem/mod.rs
similarity index 100%
rename from libs/korea/src/jauem/mod.rs
rename to libs/braillify/src/jauem/mod.rs
diff --git a/libs/korea/src/korean_char.rs b/libs/braillify/src/korean_char.rs
similarity index 100%
rename from libs/korea/src/korean_char.rs
rename to libs/braillify/src/korean_char.rs
diff --git a/libs/korea/src/korean_part.rs b/libs/braillify/src/korean_part.rs
similarity index 100%
rename from libs/korea/src/korean_part.rs
rename to libs/braillify/src/korean_part.rs
diff --git a/libs/korea/src/lib.rs b/libs/braillify/src/lib.rs
similarity index 86%
rename from libs/korea/src/lib.rs
rename to libs/braillify/src/lib.rs
index 107ed4ed..dbf82786 100644
--- a/libs/korea/src/lib.rs
+++ b/libs/braillify/src/lib.rs
@@ -30,7 +30,7 @@ mod word_shortcut;
pub fn encode(text: &str) -> Result
+
+
+
+ A template for kick starting a Rust and WebAssembly project using wasm-pack.
+
+
+
+## About
+
+[**📚 Read this template tutorial! 📚**][template-docs]
+
+This template is designed for compiling Rust libraries into WebAssembly and
+publishing the resulting package to NPM.
+
+Be sure to check out [other `wasm-pack` tutorials online][tutorials] for other
+templates and usages of `wasm-pack`.
+
+[tutorials]: https://rustwasm.github.io/docs/wasm-pack/tutorials/index.html
+[template-docs]: https://rustwasm.github.io/docs/wasm-pack/tutorials/npm-browser-packages/index.html
+
+## 🚴 Usage
+
+### 🐑 Use `cargo generate` to Clone this Template
+
+[Learn more about `cargo generate` here.](https://github.com/ashleygwilliams/cargo-generate)
+
+```
+cargo generate --git https://github.com/rustwasm/wasm-pack-template.git --name my-project
+cd my-project
+```
+
+### 🛠️ Build with `wasm-pack build`
+
+```
+wasm-pack build
+```
+
+### 🔬 Test in Headless Browsers with `wasm-pack test`
+
+```
+wasm-pack test --headless --firefox
+```
+
+### 🎁 Publish to NPM with `wasm-pack publish`
+
+```
+wasm-pack publish
+```
+
+## 🔋 Batteries Included
+
+* [`wasm-bindgen`](https://github.com/rustwasm/wasm-bindgen) for communicating
+ between WebAssembly and JavaScript.
+* [`console_error_panic_hook`](https://github.com/rustwasm/console_error_panic_hook)
+ for logging panic messages to the developer console.
+* `LICENSE-APACHE` and `LICENSE-MIT`: most Rust projects are licensed this way, so these are included for you
+
+## License
+
+Licensed under either of
+
+* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
+* MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
+
+at your option.
+
+### Contribution
+
+Unless you explicitly state otherwise, any contribution intentionally
+submitted for inclusion in the work by you, as defined in the Apache-2.0
+license, shall be dual licensed as above, without any additional terms or
+conditions.
diff --git a/packages/node/package.json b/packages/node/package.json
new file mode 100644
index 00000000..6b17e4b0
--- /dev/null
+++ b/packages/node/package.json
@@ -0,0 +1,47 @@
+{
+ "name": "braillify",
+ "description": "Braillify is a library for converting text to braille.",
+ "repository": "https://github.com/dev-five-git/braillify",
+ "author": "devfive",
+ "license": "Apache-2.0",
+ "homepage": "https://braillify.com",
+ "bugs": {
+ "url": "https://github.com/dev-five-git/braillify/issues",
+ "email": "contact@devfive.kr"
+ },
+ "keywords": [
+ "braillify",
+ "braille",
+ "braille-converter",
+ "braille-to-text",
+ "text-to-braille",
+ "wasm"
+ ],
+ "version": "0.1.0",
+ "scripts": {
+ "build": "wasm-pack build --target bundler --out-dir ./pkg --out-name index && node script.js",
+ "test": "wasm-pack test --node"
+ },
+ "publishConfig": {
+ "access": "public"
+ },
+ "sideEffects": false,
+ "main": "./pkg/index.js",
+ "module": "./pkg/index.js",
+ "files": [
+ "pkg/index.d.ts",
+ "pkg/index.js",
+ "pkg/package.json",
+ "pkg/index_bg.wasm",
+ "pkg/index_bg.wasm.d.ts"
+ ],
+ "type": "module",
+ "exports": {
+ ".": {
+ "import": "./pkg/index.js",
+ "require": "./pkg/index.js",
+ "types": "./pkg/index.d.ts"
+ }
+ },
+ "types": "./pkg/index.d.ts"
+}
\ No newline at end of file
diff --git a/packages/node/pnpm-lock.yaml b/packages/node/pnpm-lock.yaml
new file mode 100644
index 00000000..9b60ae17
--- /dev/null
+++ b/packages/node/pnpm-lock.yaml
@@ -0,0 +1,9 @@
+lockfileVersion: '9.0'
+
+settings:
+ autoInstallPeers: true
+ excludeLinksFromLockfile: false
+
+importers:
+
+ .: {}
diff --git a/packages/node/script.js b/packages/node/script.js
new file mode 100644
index 00000000..27b3139c
--- /dev/null
+++ b/packages/node/script.js
@@ -0,0 +1,4 @@
+import { writeFileSync } from 'node:fs'
+
+// support mjs config
+writeFileSync('pkg/package.json', JSON.stringify({}), 'utf8')
diff --git a/packages/node/src/lib.rs b/packages/node/src/lib.rs
new file mode 100644
index 00000000..24881aa5
--- /dev/null
+++ b/packages/node/src/lib.rs
@@ -0,0 +1,18 @@
+mod utils;
+
+use wasm_bindgen::prelude::*;
+
+#[wasm_bindgen(js_name = "encode")]
+pub fn encode(text: &str) -> Resultwasm-pack-template
+
+ A template for kick starting a Rust and WebAssembly project using wasm-pack.
+
+
+ 
+