This project was born out of a proof of concept to see whether a single core language, Typescript in this instance, could be used across the 3 core full-stack layers, ie UX, API, Data. It is technical all feasible if using MongoDB or any of the Javascript NOSQL DBs. If it proved all ok, it was intended as a Rapid Application Development Framework Template with all the good principles and patterns and core functionality such as authentication, authorisation, emailing, testing, inapp notifications, ci/cd, apis, workers, localisation/globalisation, and more; already done, with me just adding more pages, endpoints, and code services to achieve more specialised business functionalities. In essense a starter block for building more specialised bespoke web and cross-platform mobile Applications. It is also a show of how design patterns can DRASTICALLY cut sown the amount of code needed to do certain things. Take a look at the Notification System, and how inifinitely extensible it is, for me to add more notifiers like Facebook messenger, twitter dm, etc, using a strategy pattern and though the Open and Closed principle of SOLID. Object orientation is used exclusively as well (a feature that React sadly does not support fully, and which has lead to anti-patterns such as Hooks. The use of SWR Hooks was brillant for me though in decode_web)
Note:

The identity type used for objects in this library could be either a string or numeric. I designed it this way so that people have a choice of whether to go for more effiecient numeric ID or for longer string IDs. Numeric ID are easier to exploit whilst string or GUIDs are harder to do so. However SQL Server (and most other top DBMSs I believe) have a skipping mechanism which solves this security issue and does so beautifully as attempts to access phamtom Ids are detected and handled. Guids whilst good for the basic user, has the drawback of occur far more deta space that a byte id would. When coupled with table in 3NF, 4NF, 5NF this could quickly add up (when compound primary keys in 5NF, or foreign keys in 3NF) are considered.

For example: A store table in 3NF could be: -ID(Guid, 16-bytes) -CountryID (Guid, 16-bytes) -StateID (Guid, 16-bytes) -CityID (Guid, 16-bytes) -Name(char[10), 10-bytes) 74 Bytes in total

or in 5NF as -CountryID (Guid,16-bytes) -StateID (Guid,16-bytes) -CityID (Guid,16-bytes) -Name(char[10, 10-bytes) 58 bytes in toal

or (bette) as: -CountryID (numeric, 1 byte) -StateID (numeric, 1 byte) -CityID (numeric, 1 byte) -Name(char[10, 10-bytes) 13 bytes in toal

.NET also offer the impressive T4 templating features

TypeDoc Reference: Detailed on-line documentation generated using TypeDoc, providing insights into all classes, functions, interfaces, and other objects utilized throughout the API.

Dive in and start building amazing things with this API! If you have any questions or encounter issues, feel free to reach out

Explore the technical documentation

Built With:-

Road map

• [x] SCRUM Project
• [x] Public Website
• [x] Administrative Website
• [ ] Android Native Application
• [ ] IOS Native Application
• [x] Multi-language Support
  • [x] English
  • [x] French
  • [x] Punjabi
  • [ ] Spanish
  • [ ] German
• [x] Email and SMS communication
• [x] Documentation
• [x] Azure Continuous Deployment and Integration

Bugs

Report bug

Request a feature

Request a feature

Live demo of the API and web client

You can try the API demo here, and you can try the web client here.
You will need to authenticate on the web client in order to access the API endpoints that require authentication.

Reference

Explore the technical documentation

Contacts

• Name: David Ezechukwu
• Email Address: mailto:[email protected]