Skip to content

Latest commit

 

History

History
23 lines (18 loc) · 976 Bytes

README.docs.md

File metadata and controls

23 lines (18 loc) · 976 Bytes

Foreword

Welcome to the Sudok app's technical documentation! It's been automatically generated by JSDoc and is kept up-to-date through the app's releases. In these docs you'll find a description of the app's entire JavaScript API, consisting of several JavaScript modules and the symbols contained in them.

Use the menu to the right to jump to a praticular module/symbol.

Stack overview

The Sudoku app is a browser-based application with a technological stack that is simple and familiar to web developers. The main programming language used is JavaScript, the apps's templates are build with EJS which later compiles to plain HTML. The styling code is written in SASS which also compiles down to plain old CSS.

The main building basis is the Vue.js framework. The Vue-specific API style used is the Options one.