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

The minimum Litestar application
https://github.com/litestar-org/litestar-hello-world-stale

litestar litestar-api litestar-framework litestar-template starlite starlite-api starlite-framework starlite-template

Last synced: about 1 month ago
JSON representation

The minimum Litestar application

• Host: GitHub
• URL: https://github.com/litestar-org/litestar-hello-world-stale
• Owner: litestar-org
• License: mit
• Archived: true
• Created: 2022-06-19T12:24:59.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-09-16T21:28:51.000Z (over 1 year ago)
• Last Synced: 2024-08-18T14:03:02.887Z (4 months ago)
• Topics: litestar, litestar-api, litestar-framework, litestar-template, starlite, starlite-api, starlite-framework, starlite-template
• Language: Python
• Homepage:
• Size: 368 KB
• Stars: 17
• Watchers: 6
• Forks: 10
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        



  

  





[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=starlite-api_starlite-hello-world&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=starlite-api_starlite-hello-world)

[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=starlite-api_starlite-hello-world&metric=coverage)](https://sonarcloud.io/summary/new_code?id=starlite-api_starlite-hello-world)

[![Technical Debt](https://sonarcloud.io/api/project_badges/measure?project=starlite-api_starlite-hello-world&metric=sqale_index)](https://sonarcloud.io/summary/new_code?id=starlite-api_starlite-hello-world)

[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=starlite-api_starlite-hello-world&metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=starlite-api_starlite-hello-world)

[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=starlite-api_starlite-hello-world&metric=reliability_rating)](https://sonarcloud.io/summary/new_code?id=starlite-api_starlite-hello-world)

[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=starlite-api_starlite-hello-world&metric=vulnerabilities)](https://sonarcloud.io/summary/new_code?id=starlite-api_starlite-hello-world)

[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=starlite-api_starlite-hello-world&metric=bugs)](https://sonarcloud.io/summary/new_code?id=starlite-api_starlite-hello-world)

[![Discord](https://img.shields.io/discord/919193495116337154?color=202235&label=%20Discord&logo=discord)](https://discord.gg/X3FJqy8d2j) [![Matrix](https://img.shields.io/badge/%5Bm%5D%20Matrix-bridged-blue?color=202235)](https://matrix.to/#/#starlitespace:matrix.org) [![Reddit](https://img.shields.io/reddit/subreddit-subscribers/litestarapi?label=r%2FLitestar&logo=reddit)](https://reddit.com/r/litestarapi)



# litestar-hello-world

Minimum Litestar Implementation.

`$ poetry shell`

`$ poetry install`

`$ litestar run --reload`

`$ curl localhost:8000/ -w "\n"`

## To use for Litestar development

If you want to use this app to test a local version of `Litestar`, the litestar dependency in

`pyproject.toml` to:

```toml

litestar = {path = "../litestar", develop = true}

```

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

Run uvicorn with:

`$ poetry run uvicorn main:app --reload --reload-dir "../litestar/litestar"`

## Code Quality

After cloning:

`$ pre-commit install`

Run on all files:

`$ pre-commit run --all-files`

Run a specific hook:

`$ pre-commit run mypy --all-files`