/braille

A .NET REST API that manages access to a database of ASCII Braille Special Symbols.

Primary LanguageC#

BrailleAPI

The list of braille 'special symbols' is defined by committee and published in html format - https://iceb.org/symbsc2.html. This project consists of an API that makes the information accessible, searchable, and maintainable.

This will be part of a tool that will help transcribers format the Special Symbols Page in Braille transcriptions. It's also a piece of a braille training ecosystem I am designing.

My App

WALKTHROUGH

An administrative dashboard for maintaining a database of braille special symbols. Designed, tested, and deployed following Open API Specification standards using Swagger.

OPEN REQUIREMENTS

MVP

  • Can search, create, update, and delete records from the Special Symbols database.
  • Swagger documentation

COMPLETED UPDATES

PLANNED UPDATES

  • FosterPi API provides authentication using Linkedin OAuth 2.0.

Database

  • Create a service that scrapes symbols from the ICEB database
  • Load database with ICEB symbols
  • Create a service that runs the web scraper and only add unique symbols to the database

LOGIC DESIGN

BrailleSymbolsAPI provides access to the database. FosterPi API provides authentication to limit who can access and modify the database.

DATA DESIGN

SpecialSymbolsModel - ascii, name, added, updated