Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,18 @@

This service is documented at
[docs.openverse.org/api](https://docs.openverse.org/api/index.html).

## Quick Start

```bash
# Start the API server
just api/up

# Run tests
just api/test

# Run linting
just lint
```

See the [justfile](justfile) for more available commands.
15 changes: 15 additions & 0 deletions catalog/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,18 @@

This service is documented at
[docs.openverse.org/catalog](https://docs.openverse.org/catalog/index.html).

## Quick Start

```bash
# Start the catalog (Airflow)
just catalog/up

# Run tests
just catalog/test

# Run linting
just lint
```

See the [justfile](justfile) for more available commands.
15 changes: 15 additions & 0 deletions frontend/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,18 @@

This service is documented at
[docs.openverse.org/frontend](https://docs.openverse.org/frontend/index.html).

## Quick Start

```bash
# Start the development server
pnpm run dev

# Run unit tests
pnpm run test:unit

# Run E2E tests
pnpm run test:playwright
```

See [package.json](package.json) for all available scripts.
15 changes: 15 additions & 0 deletions ingestion_server/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,18 @@

This service is documented at
[docs.openverse.org/ingestion_server](https://docs.openverse.org/ingestion_server/index.html).

## Quick Start

```bash
# Start the ingestion server
just ingestion_server/up

# Run tests
just ingestion_server/test

# Run linting
just lint
```

See the [justfile](justfile) for more available commands.
14 changes: 14 additions & 0 deletions packages/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,17 @@

Learn more about these packages in the
[documentation](https://docs.openverse.org/packages/index.html).

## Available Packages

### JavaScript Packages

- `@openverse/api-client` - API client library
- `@openverse/eslint-plugin` - ESLint configuration
- `k6` - Performance testing scripts

### Python Packages

- `openverse-attribution` - Attribution utilities

See individual package directories for more details.
Loading