Introduction
Start by exploring the documentation, setting up your first service, and leveraging built-in tools to accelerate your workflow.
BE Platform goals and responsibilities
This section provides a comprehensive overview of the backend (BE) platform's goals, its core components, methodologies, and best practices. It is designed to simplify and standardize the processes of building, deploying, monitoring, scaling, and maintaining backend services, enabling both new and experienced developers to be productive and efficient.
Ultimate Goals of the BE Platform
- Simplify Service Creation: Streamlined processes for generating and bootstrapping new services.
- Effortless Deployment and Operations: Robust tools and guidelines for deploying and running services in production.
- Scalable and Maintainable Systems: Ensuring services can handle growth and remain operable over time
Getting Familiar with the BE Platform
To get started with the BE platform, you can choose between two approaches depending on your preference: diving into hands-on experience or starting with conceptual knowledge first.
A. Create a New Service Right Away
Begin your journey by directly creating and bootstrapping your first service. This hands-on approach lets you explore the platform's features through practical examples.
- Why Choose This Path?
- Learn by doing.
- Quickly get familiar with the platform's tools and capabilities.
- Get Started:
B. Learn Concepts First Through Documentation
For those who prefer a conceptual foundation, start by understanding the platform's goals, architecture, and design principles. This path helps build a comprehensive understanding before delving into implementation.
- Why Choose This Path?
- Understand the "why" and "how" behind the platform.
- Gain a clearer view of design and operational philosophies.
- Get Started:
These approaches ensure developers can easily adapt to the BE platform, whether they prefer learning through experimentation or building a strong conceptual framework first.
How to read BE platform documentation
The backend platform documentation is not intended to serve as an exhaustive, detailed reference for every implementation aspect. Instead, it focuses on highlighting the key concepts, architectural decisions, workflows, and processes that define the platform.
What to Expect
The documentation provides:
- High-level overviews of platform components and their interactions.
- Design decisions explaining the reasoning behind architectural choices.
- Important processes and best practices to guide development and operations.
Where to Find Implementation Details
For in-depth technical details such as implementation specifics, code snippets, scripts, examples, and tests, refer to the linked repositories and supplementary documents provided throughout the documentation. These external resources are maintained to be precise and up-to-date, ensuring accurate information for implementation purposes.
Purpose
The primary goal of this documentation is to provide a clear understanding of the platform's structure and design, enabling developers and stakeholders to quickly grasp how different components work together and where to find additional technical details when needed.