> ## Documentation Index
> Fetch the complete documentation index at: https://docs.opensource-together.com/llms.txt
> Use this file to discover all available pages before exploring further.

# OpenSource Together

> Documentation for contributors to OpenSource Together: discover, grow, and contribute to open-source projects with your community

<img className="block rounded-2xl" src="https://mintcdn.com/opensourcetogether/4rpRlH0916Vxmm_O/public/images/index-hero.avif?fit=max&auto=format&n=4rpRlH0916Vxmm_O&q=85&s=f48c2e211b895ff48f479819bbed0229" alt="OpenSource Together Hero" width="4096" height="1972" data-path="public/images/index-hero.avif" />

## Welcome

**OpenSource Together** helps people find open-source projects worth contributing to, and
helps maintainers find contributors. This site is the documentation for the people building
it: you.

<Card title="Run the app in two commands" icon="rocket" href="/quickstart" horizontal>
  No database, no Docker, no API keys. Really.
</Card>

## What's open source

<CardGroup cols={3}>
  <Card title="Web App" icon="palette" href="/web-app/overview">
    **Open source. Contribute here.** Next.js, React and TypeScript: project discovery,
    profiles, dashboard, and the Learn knowledge base.
  </Card>

  <Card title="API" icon="server" href="/api-reference/introduction">
    **Closed source.** A private service. You don't need it: its contract is fully documented
    and mocked locally.
  </Card>

  <Card title="AI Engine" icon="brain" href="/ai/overview">
    The data and machine-learning pipeline that collects and ranks project data. Separate
    repository.
  </Card>
</CardGroup>

<Info>
  **So how do you build anything without the API?** The repository ships a local mock of it,
  with realistic seed data. Every screen works offline. Signing in is the one exception:
  instead of OAuth, a toggle switches you between signed in and signed out. See the
  [Mock API guide](/web-app/mock-api).
</Info>

## Start contributing

<CardGroup cols={2}>
  <Card title="Get the app running" icon="play" href="/quickstart">
    Clone, install, and start in under five minutes
  </Card>

  <Card title="How to contribute" icon="code-branch" href="/contributing/contributing">
    Branches, commits, pull requests, and what CI checks
  </Card>

  <Card title="Understand the codebase" icon="sitemap" href="/web-app/architecture">
    Feature-based architecture, the data layer, and conventions
  </Card>

  <Card title="Write a Learn chapter" icon="book-open" href="/contributing/learn-content">
    Contribute content instead of code, with no TypeScript required
  </Card>
</CardGroup>

## Join the community

<CardGroup cols={3}>
  <Card title="GitHub" icon="github" href="https://github.com/opensource-together/opensource-together">
    Browse issues and open a pull request
  </Card>

  <Card title="Discord" icon="discord" href="https://discord.com/invite/4ZDhm3dQAC">
    Ask questions and meet the team
  </Card>

  <Card title="𝕏" icon="x-twitter" href="https://x.com/OpenSTogether">
    Follow along with what we ship
  </Card>
</CardGroup>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.