Welcome to the Liktik Internal Documentation Wiki, dedicated to the development of LikeTik. This wiki is intended solely for internal usage, guiding engineers and stakeholders through our services, infrastructure, and best practices.
Note: All information contained within this wiki is considered confidential and should not be shared outside the organization. Use this documentation responsibly.
-
Project Overview
- High-level overview of the backend and its core responsibilities.
- Collaboration notes on how the Application integrates with the backend.
-
Environment Setup
- Prerequisites for local development.
- Instructions on installing required tools and configuring the environment.
-
Architecture & Design
- Overview of the system architecture, modules, and their interactions.
- Data flow diagrams and integration points with the Application.
-
Backend Services
- Detailed documentation on microservices, APIs, and internal modules.
- Authentication, authorization, and security considerations.
-
Deployment & CI/CD
- Step-by-step instructions for building, testing, and deploying the backend.
- CI/CD pipelines, branching strategy, and release management.
-
Database & Data Models
- Schema design and relevant migration processes.
- Best practices for data handling and storage.
-
Application Integration
- Overview of how the backend communicates with the front-end or external services (the Application team’s domain).
- Communication protocols, versioning strategies, and troubleshooting integration issues.
-
Testing & Quality Assurance
- Unit, integration, and end-to-end testing approaches.
- Automated testing frameworks and reporting tools.
-
Monitoring & Observability
- Metrics, logging, and alerting strategies.
- Common dashboards and how to interpret them.
-
Troubleshooting & Common Issues
- Known issues, error codes, and possible root causes.
- Tips for diagnosing and resolving frequently encountered problems.
-
Contribution Guidelines
- Code style, naming conventions, and review processes.
- How to propose and merge changes to the documentation or codebase.
-
Team & Support
- List of teams, roles, and points of contact.
- Escalation paths for high-priority incidents or feature requests.