https://github.com/litestar-org/litestar-hello-world

A minimal implementation of a Litestar application
https://github.com/litestar-org/litestar-hello-world

hacktoberfest litestar litestar-api litestar-framework litestar-template

Last synced: 8 months ago
JSON representation

A minimal implementation of a Litestar application

• Host: GitHub
• URL: https://github.com/litestar-org/litestar-hello-world
• Owner: litestar-org
• License: mit
• Created: 2023-09-16T21:34:46.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-01-18T04:56:04.000Z (over 1 year ago)
• Last Synced: 2024-12-26T20:16:05.695Z (10 months ago)
• Topics: hacktoberfest, litestar, litestar-api, litestar-framework, litestar-template
• Language: Makefile
• Homepage: https://litestar.dev
• Size: 144 KB
• Stars: 12
• Watchers: 8
• Forks: 2
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          




  

  

  

  





| Project   |     | Status                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |

| --------- | :-- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

| CI/CD     |     | [![ci](https://github.com/litestar-org/litestar-hello-world/actions/workflows/ci.yaml/badge.svg)](https://github.com/litestar-org/litestar-hello-world/actions/workflows/ci.yaml) [![Documentation Building](https://github.com/litestar-org/litestar-hello-world/actions/workflows/docs.yaml/badge.svg?branch=main)](https://github.com/litestar-org/litestar-hello-world/actions/workflows/docs.yaml)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |

| Quality   |     | [![Coverage](https://sonarcloud.io/api/project_badges/measure?project=litestar-org_litestar-hello-world&metric=coverage)](https://sonarcloud.io/summary/new_code?id=litestar-org_litestar) [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=litestar-org_litestar-hello-world&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=litestar-org_litestar) [![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=litestar-org_litestar-hello-world&metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=litestar-org_litestar) [![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=litestar-org_litestar-hello-world&metric=reliability_rating)](https://sonarcloud.io/summary/new_code?id=litestar-org_litestar) [![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=litestar-org_litestar-hello-world&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=litestar-org_litestar)                                                                                                                                                                                                                       |

| Package   |     | [![PyPI - Version](https://img.shields.io/pypi/v/litestar?labelColor=202235&color=edb641&logo=python&logoColor=edb641)](https://badge.fury.io/py/litestar) ![PyPI - Support Python Versions](https://img.shields.io/pypi/pyversions/litestar?labelColor=202235&color=edb641&logo=python&logoColor=edb641) ![Starlite PyPI - Downloads](https://img.shields.io/pypi/dm/starlite?logo=python&label=starlite%20downloads&labelColor=202235&color=edb641&logoColor=edb641) ![Litestar PyPI - Downloads](https://img.shields.io/pypi/dm/litestar?logo=python&label=litestar%20downloads&labelColor=202235&color=edb641&logoColor=edb641)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |

| Community |     | [![Reddit](https://img.shields.io/reddit/subreddit-subscribers/litestarapi?label=r%2FLitestar&logo=reddit&labelColor=202235&color=edb641&logoColor=edb641)](https://reddit.com/r/litestarapi) [![Discord](https://img.shields.io/discord/919193495116337154?labelColor=202235&color=edb641&label=chat%20on%20discord&logo=discord&logoColor=edb641)](https://discord.gg/litestar-919193495116337154) [![Matrix](https://img.shields.io/badge/chat%20on%20Matrix-bridged-202235?labelColor=202235&color=edb641&logo=matrix&logoColor=edb641)](https://matrix.to/#/#litestar:matrix.org) [![Twitter](https://img.shields.io/twitter/follow/LitestarAPI?labelColor=202235&color=edb641&logo=twitter&logoColor=edb641&style=flat)](https://twitter.com/LitestarAPI) [![Blog](https://img.shields.io/badge/Blog-litestar.dev-202235?logo=blogger&labelColor=202235&color=edb641&logoColor=edb641)](https://blog.litestar.dev)                                                                                                                                                                                                                                                                                                                                        |

| Meta      |     | [![Litestar Project](https://img.shields.io/badge/Litestar%20Org-%E2%AD%90%20Litestar-202235.svg?logo=python&labelColor=202235&color=edb641&logoColor=edb641)](https://github.com/litestar-org/litestar) [![types - Mypy](https://img.shields.io/badge/types-Mypy-202235.svg?logo=python&labelColor=202235&color=edb641&logoColor=edb641)](https://github.com/python/mypy) [![License - MIT](https://img.shields.io/badge/license-MIT-202235.svg?logo=python&labelColor=202235&color=edb641&logoColor=edb641)](https://spdx.org/licenses/) [![Litestar Sponsors](https://img.shields.io/badge/Sponsor-%E2%9D%A4-%23edb641.svg?&logo=github&logoColor=edb641&labelColor=202235)](https://github.com/sponsors/litestar-org) [![linting - Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json&labelColor=202235)](https://github.com/astral-sh/ruff) [![code style - Black](https://img.shields.io/badge/code%20style-black-000000.svg?logo=python&labelColor=202235&logoColor=edb641)](https://github.com/psf/black) [![All Contributors](https://img.shields.io/github/all-contributors/litestar-org/litestar-hello-world?labelColor=202235&color=edb641&logoColor=edb641)](#contributors-) |





# litestar-hello-world

Minimal Litestar Implementation.

## Install PDM

### Linux/Mac

```shell

curl -sSL https://pdm.fming.dev/install-pdm.py | python3 -

```

### Windows

```shell

(Invoke-WebRequest -Uri https://pdm.fming.dev/install-pdm.py -UseBasicParsing).Content | python -

```

## Install litestar

```sh

pdm install

pdm venv activate

litestar run --reload

curl localhost:8000/sync -w "\n" && curl localhost:8000/async -w "\n"

```

## Litestar Development

If you want to use this app to test a local version of `Litestar`, change the litestar dependency in `pyproject.toml` to:

```toml

dev = [

    ...

    "litestar @ git+https://github.com/litestar-org/litestar.git",

]

```

...or you can add it manually with:

```shell

pdm add "git+https://github.com/litestar-org/litestar.git" --dev

```

> [!NOTE]\

> See [PDM - Editable Dependencies](https://pdm.fming.dev/latest/usage/dependency/#editable-dependencies) for more info.

Run `uvicorn` or any other ASGI-compliant server from the root of this app:

> [!IMPORTANT]\

> This assumes that `Litestar` and this app exist in the same directory.

```shell

pdm run uvicorn app:app --reload --reload-dir .

```

## Code Quality

After cloning:

```shell

pre-commit install

```

Run on all files:

```shell

pre-commit run --all-files

```

Run a specific hook:

```shell

pre-commit run mypy --all-files

```

## Docs

> [!IMPORTANT]\

> TODO