Documentation

Introduction

Welcome to FlowSync documentation. This guide will help you understand how to use FlowSync to manage your projects and collaborate with your team effectively.

FlowSync is a modern project management platform designed for teams of all sizes. Whether you're a startup or an enterprise, our flexible tools adapt to your workflow.

Quick Start

Get up and running with FlowSync in just a few minutes. Follow these steps to create your first project:

# Install FlowSync CLI
npm install -g @flowsync/cli

# Login to your account
flowsync login

# Create a new project
flowsync init my-project

# Open in browser
flowsync open

Creating Your First Project

Once you've logged in, you can create a new project from the dashboard. Click the "New Project" button and fill in the details:

{
  "name": "My First Project",
  "description": "A sample project to get started",
  "visibility": "private",
  "template": "kanban"
}

Adding Team Members

Collaboration is at the heart of FlowSync. Invite team members by navigating to Project Settings → Team and entering their email addresses.

Each team member can be assigned one of the following roles:

Admin    - Full access to all project settings
Editor   - Can create, edit, and delete tasks
Viewer   - Read-only access to the project

API Authentication

To use the FlowSync API, you'll need to generate an API key from your account settings. Include it in all requests:

curl -X GET https://api.flowsync.io/v1/projects \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

Need Help?

If you have questions or run into issues, check out our community forum or contact our support team. We're here to help!