# OpenSource Together Documentation

## Docs

- [OpenSource Together](https://docs.opensource-together.com/index.md): Documentation for contributors to OpenSource Together: discover, grow, and contribute to open-source projects with your community
- [Run the app locally](https://docs.opensource-together.com/quickstart.md): Get OpenSource Together running on your machine in two commands: no backend, no database, no credentials
- [Contributing to OST](https://docs.opensource-together.com/contributing/contributing.md): How to make your first contribution to OpenSource Together: branches, commits, pull requests, and CI
- [Writing Learn content](https://docs.opensource-together.com/contributing/learn-content.md): Contribute a chapter to the OpenSource Together Learn knowledge base. MDX only, no TypeScript required
- [Build & deployment](https://docs.opensource-together.com/contributing/deployment.md): How the OpenSource Together web app is built, published, and deployed
- [Contribute to the docs](https://docs.opensource-together.com/development.md): Run this documentation site locally, and keep the API reference in sync
- [Web App Overview](https://docs.opensource-together.com/web-app/overview.md): What the OpenSource Together web app is, what it's built with, and how it's organised
- [Setup & Scripts](https://docs.opensource-together.com/web-app/quickstart.md): The web app development environment in detail: scripts, environment variables, tooling, and project layout
- [Architecture](https://docs.opensource-together.com/web-app/architecture.md): How the OpenSource Together web app is structured: features, the data layer, conventions, and styling
- [Features & Routes](https://docs.opensource-together.com/web-app/features.md): Which feature owns what, every route in the app, and the things that catch people out
- [The Mock API](https://docs.opensource-together.com/web-app/mock-api.md): How local development works without a backend, and how to extend the mock when your feature needs a new endpoint
- [Development Guide](https://docs.opensource-together.com/web-app/development.md): Practical recipes for working in the OpenSource Together web app codebase
- [Web App FAQ](https://docs.opensource-together.com/web-app/faq.md): Common questions about developing the OpenSource Together web app
- [Overview](https://docs.opensource-together.com/ai/overview.md)
- [Pipeline](https://docs.opensource-together.com/ai/pipeline.md)
- [Structure](https://docs.opensource-together.com/ai/structure.md)
- [Installation](https://docs.opensource-together.com/ai/installation.md)
- [Troubleshooting](https://docs.opensource-together.com/ai/troubleshooting.md)
- [API Reference](https://docs.opensource-together.com/api-reference/introduction.md): How the OpenSource Together API works: base URLs, response envelopes, errors, and authentication
- [List projects with filters and pagination](https://docs.opensource-together.com/api-reference/endpoint/project/list-projects-with-filters-and-pagination.md): Get all published projects with optional filters, pagination, and repository information
- [Create a new project](https://docs.opensource-together.com/api-reference/endpoint/project/create-a-new-project.md): Create a new project for the authenticated user
- [Get a project by id](https://docs.opensource-together.com/api-reference/endpoint/project/get-a-project-by-id.md): Get a project by id
- [Update a project](https://docs.opensource-together.com/api-reference/endpoint/project/update-a-project.md): Update an existing project (only allowed by project owner)
- [Delete a project](https://docs.opensource-together.com/api-reference/endpoint/project/delete-a-project.md): Delete an existing project (only allowed by project owner)
- [Get project repository summary](https://docs.opensource-together.com/api-reference/endpoint/project/get-project-repository-summary.md): Retrieve repository information (stars, forks, issues, etc.) from the Git provider
- [Get project issues](https://docs.opensource-together.com/api-reference/endpoint/project/get-project-issues.md): Retrieve all issues from the project repository
- [Get a project issue](https://docs.opensource-together.com/api-reference/endpoint/project/get-a-project-issue.md): Get detailed information about a specific issue from a project
- [Claim project ownership](https://docs.opensource-together.com/api-reference/endpoint/project/claim-project-ownership.md): If the project has no owner, a user with repository access can claim it.
- [Add project to bookmarks](https://docs.opensource-together.com/api-reference/endpoint/project/add-project-to-bookmarks.md): Add a project to the authenticated user bookmarks
- [Remove project from bookmarks](https://docs.opensource-together.com/api-reference/endpoint/project/remove-project-from-bookmarks.md): Remove a project from the authenticated user bookmarks
- [Update project logo](https://docs.opensource-together.com/api-reference/endpoint/project/update-project-logo.md): Replace the project logo with a custom image. Accepts PNG, JPEG, or WEBP format. Maximum file size: 5MB.
- [Add image to project gallery](https://docs.opensource-together.com/api-reference/endpoint/project/add-image-to-project-gallery.md): Upload an image to the project gallery (maximum 5 images per project). Accepts PNG, JPEG, or WEBP format. Maximum file size: 10MB.
- [Remove image from project gallery](https://docs.opensource-together.com/api-reference/endpoint/project/remove-image-from-project-gallery.md): Delete an image from the project gallery by providing its URL.
- [Get current authenticated user](https://docs.opensource-together.com/api-reference/endpoint/user/get-current-authenticated-user.md): Returns the current authenticated user with GitHub contribution graph and connected providers (GitHub, GitLab, Google) if available
- [Get a user by id](https://docs.opensource-together.com/api-reference/endpoint/user/get-a-user-by-id.md): Get a user by id
- [Update a user](https://docs.opensource-together.com/api-reference/endpoint/user/update-a-user.md): Update an existing user with the provided data
- [Update user profile picture](https://docs.opensource-together.com/api-reference/endpoint/user/update-user-profile-picture.md): Replace the user profile picture with a custom image. Accepts PNG, JPEG, or WEBP format. Maximum file size: 5MB.
- [Update user banner](https://docs.opensource-together.com/api-reference/endpoint/user/update-user-banner.md): Replace the user banner with a custom image. Accepts PNG, JPEG, or WEBP format. Maximum file size: 5MB.
- [List user projects](https://docs.opensource-together.com/api-reference/endpoint/user/list-user-projects.md): Get a paginated list of projects for the authenticated user
- [List projects by user ID](https://docs.opensource-together.com/api-reference/endpoint/user/list-projects-by-user-id.md): Get a paginated list of projects for a specific user
- [List user bookmarked projects](https://docs.opensource-together.com/api-reference/endpoint/user/list-user-bookmarked-projects.md): Retrieves all projects bookmarked by the authenticated user with pagination support.
- [List user repositories from GitHub or GitLab](https://docs.opensource-together.com/api-reference/endpoint/user/list-user-repositories-from-github-or-gitlab.md): Retrieves repositories for the authenticated user. Returns a structured response with github and gitlab properties, containing repositories for each provider (or null if not connected/fetched).
- [List user pull requests from GitHub or GitLab](https://docs.opensource-together.com/api-reference/endpoint/user/list-user-pull-requests-from-github-or-gitlab.md): Retrieves pull requests for the authenticated user. Returns a structured response with github and gitlab properties, containing pull requests for each provider (or null if not connected/fetched).
- [List user pull requests from GitHub or GitLab](https://docs.opensource-together.com/api-reference/endpoint/user/list-user-pull-requests-from-github-or-gitlab-1.md): Retrieves pull requests for the authenticated user. Returns a structured response with github and gitlab properties, containing pull requests for each provider (or null if not connected/fetched).
- [Get all tech stacks](https://docs.opensource-together.com/api-reference/endpoint/techstacks/get-all-tech-stacks.md): Retrieve all available tech stacks ordered by type and name
- [Get all categories](https://docs.opensource-together.com/api-reference/endpoint/categories/get-all-categories.md): Retrieve all available categories
- [Check app's health](https://docs.opensource-together.com/api-reference/endpoint/health/check-apps-health.md): Check app's health

## OpenAPI Specs

- [openapi](https://docs.opensource-together.com/api-reference/openapi.json)

## Optional

- [GitHub](https://github.com/opensource-together/opensource-together)
- [Discord](https://discord.com/invite/4ZDhm3dQAC)
- [Open the app](https://opensource-together.com)