https://github.com/JacobCoffee/litestar-template

Litestar template for Railway
https://github.com/JacobCoffee/litestar-template

litestar litestar-api litestar-framework litestar-template railway railway-app

Last synced: 5 months ago
JSON representation

Litestar template for Railway

• Host: GitHub
• URL: https://github.com/JacobCoffee/litestar-template
• Owner: JacobCoffee
• License: mit
• Created: 2023-07-26T23:43:24.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-10-10T17:40:17.000Z (6 months ago)
• Last Synced: 2024-10-31T01:02:53.638Z (6 months ago)
• Topics: litestar, litestar-api, litestar-framework, litestar-template, railway, railway-app
• Language: CSS
• Homepage: https://railway.app/template/zx1KGh?referralCode=BMcs0x
• Size: 259 KB
• Stars: 6
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.rst
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

• awesome-litestar - Basic Litestar App - Basic Litestar app with TailwindCSS. (Third-Party Extensions / Projects)

README

        



  

  





| Project   |     | Status                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |

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

| CI/CD     |     | [![ci](https://github.com/JacobCoffee/litestar-template/actions/workflows/ci.yaml/badge.svg)](https://github.com/JacobCoffee/litestar-template/actions/workflows/ci.yaml) [![Pip Audit](https://github.com/JacobCoffee/litestar-template/actions/workflows/audit.yaml/badge.svg)](https://github.com/JacobCoffee/litestar-template/actions/workflows/audit.yaml) [![Test](https://github.com/JacobCoffee/litestar-template/actions/workflows/test.yaml/badge.svg)](https://github.com/JacobCoffee/litestar-template/actions/workflows/test.yaml)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |

| Quality   |     | [![codecov](https://codecov.io/gh/JacobCoffee/litestar-template/branch/main/graph/badge.svg?token=SFT67X4MEQ)](https://codecov.io/gh/JacobCoffee/niapi) [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=JacobCoffee_litestar-template&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=JacobCoffee_litestar-template) [![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=JacobCoffee_litestar-template&metric=reliability_rating)](https://sonarcloud.io/summary/new_code?id=JacobCoffee_litestar-template) [![Duplicated Lines (%)](https://sonarcloud.io/api/project_badges/measure?project=JacobCoffee_litestar-template&metric=duplicated_lines_density)](https://sonarcloud.io/summary/new_code?id=JacobCoffee_litestar-template) [![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=JacobCoffee_litestar-template&metric=vulnerabilities)](https://sonarcloud.io/summary/new_code?id=JacobCoffee_litestar-template) [![Bugs](https://sonarcloud.io/api/project_badges/measure?project=JacobCoffee_litestar-template&metric=bugs)](https://sonarcloud.io/summary/new_code?id=JacobCoffee_litestar-template) |

| 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/X3FJqy8d2j) [![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) [![Medium](https://img.shields.io/badge/Medium-202235?labelColor=202235&color=edb641&logo=medium&logoColor=edb641)](https://blog.litestar.dev) [![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%20Framework-202235.svg?logo=python&labelColor=202235&color=edb641&logoColor=edb641)](https://github.com/litestar-org/litestar) [![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) [![types - Mypy](https://img.shields.io/badge/types-Mypy-202235.svg?logo=python&labelColor=202235&color=edb641&logoColor=edb641)](https://github.com/python/mypy)                                                                                                                     |

[![SonarCloud](https://sonarcloud.io/images/project_badges/sonarcloud-white.svg)](https://sonarcloud.io/summary/new_code?id=JacobCoffee_litestar-template)



# Litestar Template for [Railway](https://railway.app/template/zx1KGh?referralCode=BMcs0x).

This repo is a template for creating a Litestar app on Railway.

[![Deploy on Railway](https://railway.app/button.svg)](https://railway.app/template/zx1KGh?referralCode=BMcs0x)

## Development

For working on this template, you'll need to clone the repo and set up for development environment.

1. Clone [the repo](https://github.com/JacobCoffee/litestar-template)

2. Install [Python Development Master (`PDM`)](https://pdm.fming.dev/latest/)

3. TODO