https://github.com/lfost42/braillesort
Formats ASCII-Braille symbols into braille order for proper transcription of the Special Symbols Page as required by the Braille Authority of North America.
https://github.com/lfost42/braillesort
asp-net-core-mvc braille csharp dapper-donet-core data-access-object-pattern identity ms-sql-server roles sql ueb
Last synced: 4 months ago
JSON representation
Formats ASCII-Braille symbols into braille order for proper transcription of the Special Symbols Page as required by the Braille Authority of North America.
- Host: GitHub
- URL: https://github.com/lfost42/braillesort
- Owner: lfost42
- Created: 2021-11-19T21:21:44.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-05-18T04:35:38.000Z (about 3 years ago)
- Last Synced: 2025-01-18T14:22:58.184Z (5 months ago)
- Topics: asp-net-core-mvc, braille, csharp, dapper-donet-core, data-access-object-pattern, identity, ms-sql-server, roles, sql, ueb
- Language: C#
- Homepage:
- Size: 30.8 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# BrailleSort
Formats ASCII-Braille symbols into braille order for proper transcription of the Special Symbols Page as required by the Braille Authority of North America.
## WALKTHROUGH
Minimal Viable Product:
- [BrailleSymbolsAPI](https://github.com/lfost42/BrailleSymbols) allows admins to maintain the special symbols database and users to query it.
- IssueTrackingAPI allows users to report errors/discrepancies in the database or suggest app changes.
Other Planned Features:
- Ability to search for symbols.
- Ability to select a symbol and add it to a list that is sorted into ASCII-braille order.
- Add 'dot locator' and special symbol description (for formatting of the Braille Special Symbols page)
Sort a pasted list into ASCII-braille order
- Alert user when a symbol includes a character that is not ASCII-braille
- Alert user when a symbol was not found in the database
- user may request alerted symbol be added to the database
- Issue System allows users to report bugs/errors and admins to assign/solve them
## OPEN REQUIREMENTS
- landing page will allow users to query the special symbols database
- options to build the special symbols page or sort a list of symbols
- app alerts user when symbol includes a character that is not ASCII braille
- app alerts user when a symbol is not found in the database
- user files ticket to add symbol to database
- user login/registration for creating/reporting issues
- proposed modifications to application
- assign issues to other admins for research purposes
## USER INTERFACE
MVP:
- Landing page
- Area to paste a list of special symbols for sort
- Sort button
Other features:
- Login option
- Search Symbols
- Option to export a csv of the symbols database
- profile management
- role management
- issue management
## LOGIC DESIGN
- identity access
- role based security
- tracking for issues
## DATA DESIGN
### BrailleSymbolsAPI
- symbol - str
- symbol name - str
### FosterPI (Authentication API)
- admin - str
- visitor - str
- owner - str
### IssueTrackerAPI
- ticket - list
- priority - enum
- type - str
- Date Created - datetime
- IsClosed - boolean
- Date Closed - datetime
- notes
- note - str
- ticket id
- date created - datetime
- date updated - datetime
\* The 64 ASCII-braille characters in 'braille order': abcdefghijklmnopqrstuvxyz&=(!)*<%?:$]\\[w1234567890/+#>'-@^_\".;,
There are currently 510 known symbols listed in the ICEB database http://www.iceb.org/symbsc2.html