Skip to content

update server setup documentation in readme #593

@zven

Description

@zven

Our readme is currently quite outdated regarding the server setup. This relates to setting up a local development system and (potentially) also our an actual instance for production use.

While trying to set up the project from scratch on my machine, I stumbled across some issues:

  • Reference pyproject.toml and not .pre-commit-config.yaml in "How to get started on your local development environment."
  • In addition, dependency managament is now done via uv. In order to execute uv sync on a Mac, I went through the following steps:
    • brew install uv
    • brew reinstall python
    • brew install mysql

Please not the the list above is not exhaustive.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions