Introduction
BackBone is a developer platform, with a growing number of services (AKA BaaS Products), the aim is not only to provide backend services but also the foundation the developer needs to build thier project appon, we call this Vitals.
Repo Chat Project EndpointGetting Started
There are two senarios for getting started. First "Internal", you are getting started on the development of BackBone itself. Sedond "External", these are the steps for how to get started using BackBone as a developer or business.
This document is not meant to outline how to use the API endpoints, rather how to build it. We outline what it's capabilities should be, once you have built them, you can creat documentation on how to utilize them on the APIs tab.
- Internal
- External
Internal
Description
Here you will find all the details you need in order to get started working on BackBone or a BackBone Product.
Your Employment
It is important to note that while you are working directly for BackBone and on BackBone projects, you are employed by Calm Experts and therfore sould adhear to all Calm Experts Guidelines and Code of Conduct.
Confidentiality
If you have not signed an NDA with 10/10, BackBone, Calm Experts or any of its subsidiaries, you are not permitted to have access to this document nor any of its associated documents. If you are an employee or contractor with any of these companies or brands, you are bound by your Employment Agreement, NDA, our Code of Conduct and Development Guidelines. Make sure you have refreshed your memory on all these internal guidelines before reading this document or working on this project.
Onboarding
Please follow the onboarding guide from Calm Experts
Knowladge Base
While you will gain a lot of Knowladge from the Calm Experts Docs, be sure to learn the BackBone spesifict Knowladge as well.
Tech Stack
You will find a general Tech Stack document within the Knowladge, however, be sure to check each project's Tech Stack document.
Status
These details are only updated with each release, for more acurate updates and keeping track of progress, see the task in GitHub.
| Doc Status | Product Status | Last Update | Version | Release | Phase |
|---|---|---|---|---|---|
| In Progress | Up Next | 04.03.2024 | 0.01 | Internal | Alpha |
Team
| Product Owner | Lead | Member #1 | Member #2 |
|---|---|---|---|
| Mendy | Esti | Nir | - |
Reminders
- Keep code lean and clear
- follow the outlined arcetecture
- write commetes in your code
- update the staus in the docs and in GitHub
- try not to recreate functions we alredy have, rather update exsiting functions to support your needs
- Be sure to follow the release guidelines
- Update Documentation
- keep API docs up to date each time you update or add endpoints
Links & Resources
Coming Soon
- Biz Docs
- Research
- Design
- Prototype
- Dev Mode
- Task
- Alpha Branch
- Chat
- Alpha
- Beta
- Production
User Stories
Persona One
Update Coming Soon
As a busy user I don’t want to watch but rather listen to a podcast, however, when I hear a voice I don’t recognize, I want to take a glance at my phone to see a name and/or photo of who is talking or maybe ask the built-in “AI/assistant”.
Features
Below is a list of features that will be utilized in order to deliver a great podcast experiance. The details bellow are not comprehensive feature details but rather, describe how the features will be utilized withon the podcast product, for further details, please see the individual feature documentation.
replace with cards
External
Description
Here you will find all the details you need in order to get started using BackBone as a developer or business.
Step One - Client Account
In order for a developer or business to "Get Started" with using BackBone, they will first need to create an account, we call this a Client Account, this means they are a client of BackBone, this could be an indevidual client or a corporate client, the diference is only in whitere other client account can access the. In the future there may also be legal diferences. To fully understand this feature, see Client Account.
Step Two - Project
Now its time to create a dedicated space for the product/app the Client wants to build, this is a Project.
Step Three Vitals (Optinal)
The Client can now choose from a variaty of Vitals, to support thier project so they can focus on the core features and not the basics all apps need.
-
setting up billing
-
Choosing a plan
-
enabling endpoints or full APIs
-
invting team members The developer can invite team member to have access to the entire account or to a single project and event detail the level of access and to what data within the account or project (e.g. billing and analytics only, upload only, etc.)
-
and more
Status
These details are only updated with each release, for more acurate updates and keeping track of progress, see the task in GitHub.
| Doc Status | Product Status | Last Update | Version | Release | Phase |
|---|---|---|---|---|---|
| In Progress | In Progress | 04.03.2024 | 0.01 | Internal | Alpha |
Team
| Product Owner | Lead | Member #1 | Member #2 |
|---|---|---|---|
| Mendy | Esti | Nir | - |
Reminders
Links & Resources
User Stories
Persona One
Update Coming Soon
As a busy user I don’t want to watch but rather listen to a podcast, however, when I hear a voice I don’t recognize, I want to take a glance at my phone to see a name and/or photo of who is talking or maybe ask the built-in “AI/assistant”.
Features
Below is a list of features that will be utilized in order to deliver a great podcast experiance. The details bellow are not comprehensive feature details but rather, describe how the features will be utilized withon the podcast product, for further details, please see the individual feature documentation.