Home

Squared Developer Documentation

Welcome to the official developer documentation for Squared, a task management application for developers. This documentation is intended for developers working on the Squared project.

Project Overview

Squared is a monorepo project consisting of three main components:

1. Landing Page Server (www): The public-facing website for Squared.
2. Web Application (web): The main Squared application used by end-users.
3. Backend API (api): The server-side application handling data and business logic.

Getting Started

• Development Environment Setup
• Project Structure
• Coding Standards

Component Documentation

Landing Page (www)

• Overview
• Page Components
• Deployment

Web Application (web)

• Architecture
• State Management
• Component Library
• Routing
• Testing

Backend API (api)

• API Design
• Database Schema
• Authentication
• Middleware
• Testing

Development Workflows

• Git Workflow
• CI/CD Pipeline
• Code Review Process

API Reference

• API Endpoints
• Data Models
• Error Handling

Contributing

• How to Contribute
• Reporting Bugs
• Proposing New Features

Troubleshooting

• Common Issues
• Debugging Guide

Changelog

• Version History

For any questions or support, please contact the lead developers or open an issue in the project repository.