Skip to content

Quick Start Guide

Prerequisites

You should install Rye and Docker and Docker Compose on your machine.

Installation

Provide a brief, step-by-step guide on how to install your project.

Basic Usage

Install the Rye.

rye sync --all-features

Lint

rye shell
rye run format
rye run check:ruff
rye run typecheck

Deploy

cd Dockerfile
docker-compose up -d

Then you will look your browser with 127.0.0.1:8080

Troubleshooting

Provide solutions to common issues that a new user might encounter.

Issues