Welcome to Viventio Technical Documentation

Welcome to Viventio's technical knowledge hub. This documentation has been created to help developers, architects, and technical team members understand, contribute to, and maintain our systems with excellence.

About This Repository

This documentation book contains all essential technical knowledge about the architecture, development patterns, testing, and best practices used at Viventio. Our goal is to ensure that the entire team has clear and organized access to the information needed to develop high-quality solutions.

Documentation Structure

Our documentation is organized into two main areas:

Frontend

Documentation about our user interfaces and client-side applications.

• Overview - Introduction to Viventio's frontend
• General Guidelines - Frontend code standards and conventions

Next.js

• Development Guidelines - Frontend code standards and conventions for Next.js
• Architecture - Next.js application structure and patterns
• Testing - Testing strategies for Next.js applications

SvelteKit

• Architecture - SvelteKit application structure and patterns

Backend

Complete documentation about our server infrastructure, APIs, and services.

• Overview - Introduction to Viventio's backend

Python

• Architecture - Backend systems structure and design
• Database - Schemas, models, and data best practices
• Development Guidelines - Code standards and conventions
• Testing - Backend testing strategies and practices

Getting Started

If you're new to the Viventio codebase, we recommend following this learning path:

1. Start with the Overview - Read the README files in both backend and frontend sections.
2. Understand the Architecture - Review the architecture documents to grasp system design.
3. Learn the Guidelines - Familiarize yourself with our coding standards and conventions.
4. Explore Testing Practices - Understand how we ensure code quality.

Technology Stack

Backend

Our backend infrastructure powers the core business logic and data management. We normally use Python for our backend development with a handcrafted architecture that heavily utilizes the following technologies:

• Poetry - Python package manager.
• FastAPI - Python framework for building APIs.
• SQLAlchemy - Object-relational mapping (ORM) for database interactions.
• PostgreSQL - Open-source relational database.
• Docker & Docker Compose - Containerization for consistent environments.

Frontend

We utilize modern frameworks to deliver exceptional user experiences:

• Next.js - React-based framework for production-grade applications
• SvelteKit - Modern framework for building fast, efficient web applications

How to Use This Documentation

• Browse by Topic - Use the structure above to navigate to specific areas.
• Search - Use your documentation tool's search feature to find specific topics.
• Contribute - Help keep this documentation up-to-date by submitting. improvements.
• Ask Questions - If something is unclear, reach out to the team.

Contributing

This documentation is a living resource that evolves with our systems. If you find gaps, errors, or opportunities for improvement, please contribute! Clear documentation benefits everyone on the team.

Support

For questions about this documentation or technical guidance, please reach out to Hícaro Dânrlley.

Maintained by: Hícaro Dânrlley - the CTO of Viventio.