> For the complete documentation index, see [llms.txt](https://slush.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://slush.gitbook.io/docs/readme.md).

# Developer Platform

Welcome to your team’s developer platform

<figure><img src="https://3552808246-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYkTyEtTO3C3EjnphROd6%2Fuploads%2FGCAjZcVmxYyh1eAt6usv%2FChatGPT%20Image%20Apr%2024%2C%202026%2C%2004_23_53%20AM%20(1).png?alt=media&amp;token=6f109126-d418-4445-96ac-2464fb93374e" alt="" width="344"><figcaption></figcaption></figure>

<h3 align="center"><strong>Slush</strong> is a lightweight Python web framework designed for clarity, extensibility, and performance.</h3>

{% code overflow="wrap" %}

```python
from slush.app import Slush

app = Slush()

@app.route("/hello")
def hello(request):
    return {"message": "Hello from Slush"}
```

{% endcode %}

###

<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="image">Cover image</th></tr></thead><tbody><tr><td><h4><i class="fa-leaf">:leaf:</i></h4></td><td><strong>Documentation</strong></td><td>Get started with the framework</td><td><a href="https://slush.gitbook.io/docs/documentation/">Documentation</a></td><td><a href="https://3552808246-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYkTyEtTO3C3EjnphROd6%2Fuploads%2FXnpOSL6WPcLBAfAIdAeg%2FScreenshot%202026-04-24%20034919.png?alt=media&amp;token=d072e8c3-d210-45e5-9d85-e83a6bc9f3b0">Screenshot 2026-04-24 034919.png</a></td></tr><tr><td><h4><i class="fa-github">:github:</i></h4></td><td><strong>Github</strong></td><td>Head to our GitHub repository to submit PR.</td><td><a href="https://github.com/farazkhanfk7/slush">https://github.com/farazkhanfk7/slush</a></td><td><a href="https://3552808246-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYkTyEtTO3C3EjnphROd6%2Fuploads%2FmHQYwZ91nQN799n0EYej%2FScreenshot%202026-04-24%20035535.png?alt=media&amp;token=bb0ac945-a004-40c1-ad3d-0305bec54202">Screenshot 2026-04-24 035535.png</a></td></tr></tbody></table>

###

***

{% columns %}
{% column %}

### Get started in 5 minutes

Setting up your first API call should be the easiest part of getting started. With clear endpoints, copy-paste-ready examples, and quick authentication, you’ll be up and running in minutes, not hours.

No guesswork, no complexity, just your first successful call, fast.

<a href="/docs/documentation/readme.md" class="button primary" data-icon="rocket-launch">Get started</a> <a href="/docs/documentation/basics/routing.md" class="button secondary" data-icon="terminal">Documentation</a>
{% endcolumn %}

{% column %}
{% code title="users.py" overflow="wrap" %}

```python
from pydantic import BaseModel
from slush.core.response import Response
from slush.core.routing import Router

class UserCreate(BaseModel):
    name: str
    age: int

user_router = Router()

```

{% endcode %}
{% endcolumn %}
{% endcolumns %}

***

{% stepper %}
{% step %}

### Install Slush

{% code overflow="wrap" %}

```bash
$ pip install slush
```

{% endcode %}
{% endstep %}

{% step %}

### Run your project

{% code overflow="wrap" %}

```bash
$ slush runserver main:app
```

{% endcode %}
{% endstep %}
{% endstepper %}

<h2 align="center">Join Us in Building Slush Together</h2>

{% columns %}
{% column %}
Slush is built with collaboration at its core. We welcome contributions from developers, designers, and creators who want to improve the project and build something meaningful together.
{% endcolumn %}

{% column %}

<p align="center">To get started, simply fork the repository, make your changes, and open a pull request. Whether it’s fixing bugs, improving documentation, or adding new features — every contribution counts.</p>
{% endcolumn %}
{% endcolumns %}

<p align="center"></p>
