Skip to content

Latest commit

 

History

History
150 lines (95 loc) · 6.53 KB

README.md

File metadata and controls

150 lines (95 loc) · 6.53 KB
Raw

Grammar Tutorial

React 17 Demo app

Live site: https://srpska-gramatika.web.app

Features

Separating UI and logic

The React UI is completely isolated in the folder https://github.com/s4ysolutions/srpska-gramatika/tree/main/src/react The main part of logic resides within the folder https://github.com/s4ysolutions/srpska-gramatika/tree/main/src/tutor

Logic related code exposes API via setters, promises and RXJS observables defined as interfaces https://github.com/s4ysolutions/srpska-gramatika/blob/main/src/tutor/index.ts

The clue between the logic and UI implemented through the custom hooks useObservable and usePromise

Implementations

Logic interfaces implemented with Default* classes generally for sake of testing but also keeping in mind the easy refactoring and evolving.

Implementation is layered by problem-level API and db-access level API. The latter is not supposed to be called from UI code and contains 2 key-value storages: one with immediate available snapshots (implemented with Local Storage) and promise results assuming network requests ([implemented with IndexDB] (https://github.com/s4ysolutions/srpska-gramatika/tree/main/src/kv/promise)).

Both storages provide observables to let the consumers be notified about the storage changes through RXJS observables.

Dependency injection

For sake of better manageability DI is implemented as very simple service locator singleton with the only practical purpose to be mocked by tests.

Localization

The multi-language support implemented with simple and fast but pretty convenient module l10n providing the string interpolation function to be used as simple as

    T`Text to be localized`

while the translations are provided by JS object https://github.com/s4ysolutions/srpska-gramatika/blob/main/src/l10n/translations.ts

React UI

UI is implemented with React and Material UI in straightforward manner with the only important feature it does not use any state management engines like Redux or Mobx. Instead, UI manipulates logic code through the API and reacts on the changes via custom hooks.

Testing

The logic code is very modularized in order to be covered with mocha unit tests.

TODO: UI is supposed to be tested with Jest.

ES6 modules

By default, all JS files are treated as ES6 modules. This why the non-ES6 js files have extension .cjs.

Packaging with WebPack

WebPack configuration consists from 4 files:

https://github.com/s4ysolutions/srpska-gramatika/blob/main/webpack.config-common.cjs https://github.com/s4ysolutions/srpska-gramatika/blob/main/webpack.config-dev.cjs https://github.com/s4ysolutions/srpska-gramatika/blob/main/webpack.config-prod.cjs https://github.com/s4ysolutions/srpska-gramatika/blob/main/webpack.config-stats.cjs

where webpack.config-common.cjs is shared by others 3.

Passing the one of 3 files to WebPack with "webpack --config webpack.config-*.cjs", either launches dev server or produces production ready ./dist folder. webpack.config-stats.cjs is used to get information about the content of built bundle.

CI/CD with GitHub actions

The pushing to the main branch triggers the build and deploy to Firebase pipeline. https://github.com/s4ysolutions/srpska-gramatika/blob/main/.github/workflows/main.yml

Typescript

All the code, including tests, is 100% typed with TypeScript.

Progressive Web App

In order to be used on the mobile devices without access to internet the app registers the worker that caches the JS bundle built by WebPack and intercept all the fetches to look into the cache for the resource first.

Adding new lessons

Create exercises database

The database must implement either NounsDb or VerbsDb interfaces;

Currently, databases are implemented with static JS-objects in src/tutor/databases folder. Either some of existing ones can be used as starting point or the DB can be created from scratch;

Add a new lesson to tutor

Add an instance of the database

The instances of databases are kept as fields of the class DefaultTutor in src/tutor/tutor/default-tutor.ts but created outside the class and passed by a constructor arguments;

Register new lesson

Add another constant to enum Lesson in src/tutor/index.ts.

Setup database for the lesson

Choose the correct database instance according to the selected lesson in nextConjugationExercise or nextCaseExercise in src/tutor/tutor/default-tutor.ts.

Set up router

Add a constant to the enum RouteId and property to the interface Router in src/router/index.ts.

Add a field satisfying Route interface's property to the DefaultRouter class in src/router/default.ts and a case branch within go(routeId: RouteId): void method of the same class.

Also, it is a good time to add a translation of the route title to src/l10n/transalations.ts

Fix DI

The class DefaultTutor receives the necessary components from the outside, and they must be created by DI service in the file src/di/defaults.ts. This is the place where the database instantiated.

First add a property to interface Di in src/index.ts and next assign the instance of the database to the property.

Add menu item

The folder src/react/components/TopNavigator/menu-items contains MenuItem* react components to display the name of new lesson (usually picked up from the Router object), to select the lesson with Tutor.selectLesson method (so tutor knows the databse to use) and callgo method of the Router instance (cause UI to reflect new state).

Add the new menu item to src/react/components/TopNavigator/MenuMain.tsx component.

Show the lesson screen

The component src/react/components/Workspace/index.tsx observes the router state and selects the content according to routeId state variable. There are 2 universal components NounCases and VerbConjugation to show lessons of the tutor. Because the same component used for different lesson it necessary to have key attribute of them in order to force them to be re-rendered on route change.