Definitions
Before dving into the documentation, here are some termes you should be familiare with.
This document only contains definitions related to the Hudi products and developent, make sure you are also familiare with the Calm Experts Definitions
Business Definitions
Hudi (AKA Hudi App)
Refers to the Hudi app as a whole, that includes all Products (including but not limited to Everything, "Podcasts", "Music", etc.). Hudi refers to all "Products" shipped within the Hudi app including android, iOS and web.
Hudi Inc.
Refers to the corporation that holds the rights,tradmarks and owns Hudi, it's codebase, data and all its assets.
Everything (AKA Hudi Everything)
Refers to the core features, anything that is not considered it's own "Products" is housed within "Everything" or core of the Hudi app.
Hudi API (aka the API)
Refers to the API used to connect with the Hudi backend. This should not be confused with BackBone CMS or any "third party" "API".
Third-Party
is a software or other entity that is not part of Hudi or Hudi Inc.
User Interface (UI)
The user interface (UI) is the point of human-computer interaction and communication in a device. This can include display screens, keyboards, a mouse and the appearance of a desktop.
User Experience (UX)
is how a user interacts with and experiences a product, system or service. It includes a person's perceptions of utility, ease of use, and efficiency.
Documentation Definitions
Grey
The documentation is meant to be focused on the immediate development (the prototype) however in order to keep the documentation for future development consistent we will include any information in this document in a grey colour.
Product Definitions
These are proconts and tools we use in the process of development and managing
Google Chat
is a communication software built for teams.
Google Drive
is a file storage and synchronization service.
Jira
is a software for project management we use to organize tasks.
Google Cloud Platform (aka GCP)
is a provider of computing resources for deploying and operating applications where we can build and run the software. It uses the web to connect to the users of that software.
Flutter
Flutter is Google’s UI toolkit for building natively compiled applications for mobile, web, and desktop from a single codebase.
Dart
is the programming language used to code Flutter apps.
Firebase
is a BaaS that provides a variety of tools like database, authentication and other services to have quality apps.
Cloud Firestore
is a NoSQL document database that can be used to store, sync, and query data.
GitHub
is a provider of Internet hosting for software development and version control using Git.
Git
is a distributed version control system for tracking changes in any set of files. When we use Git, all your work is safe; if someone makes changes to your code and something goes wrong, we can easily revert that.
Repository
is a storage location for all the code from a project.
Fork
a project fork happens when developers download the code from a repository and start developing it locally on their machines, creating a distinct and separate piece of software. After they finish their work, they push the changes to the original repository and merge both codes.
Pull request
is a request to review and merge two different codes.
Push
is the act of moving the code written locally inside a computer into the repository.
BackBone Commerce
BackBone CMS
BackBone Payments
Stripe
Technical Definitions
PWA
is an abbreviation for Progressive Web Apps, web applications that have similar behavior as mobile applications.
MVP
is an abbreviation for Minimum Viable Product.
PWA
NoSQL is a type of database where the pieces of data cannot be related to one another.
SQL
is a type of database where all the data can be related to one another.
BaaS
Backend as a Service. This is when there is a product that can be used as a backend rather than developing one.
API
is a piece of software that connects two different applications. It basically enables one application to talk to another, and this information is shared between them both.
SDK
provides a set of tools that allow developers to create software applications on a specific platform.
Code manager
is a source code control system based on Git.
Database
is a collection of information, usually organized inside a server, that we can easily access, manage and update.
Server
is a piece of computer hardware or software (computer program) that provides functionality for other programs or devices, called "clients", storing data and running tasks.
Frontend
is the part of the application with which the user interacts directly.
Plugin
is a software component that adds a specific feature to an existing computer program.
State manager
is a way to control the state of the views, choosing what to display when the user performs an action. For example, if the user presses a button, the state of the background colour can change to blue.
Backend
is the part of the application that is not directly accessed by the user, responsible for storing and manipulating data. It’s also responsible for complex functions.
Programming languages
are used in computer programming to implement algorithms and consist of instructions for computers.
Project Manager
is the person responsible for overseeing the project and ensuring all developers, designers and all parties are up to date with the documentation, tasks and meet deadlines.
Node.JS:
The programming language will be used to build the project's API in Firebase and integrate the project's API with Stripe's API.
User Interface
is the process of building interfaces in an application or computer program, focusing on looks or style.
User Experience
is the process of creating products that provide meaningful and relevant experiences to users.
Features Definitions
Content Format (AKA Format)
when referring to the term “format” we are referring to the functionality needed or file format on content such as audio, video, text, etc.
Content Type (AKA Type)
when mentioning “Type” or “content type” we are talking about News, Music, Podcasts, recipe, auction, etc.
Category
when talking about category (may also be a sub-category) we mean, topic (e.g. food, shopping, etc.)