TAROTPEDIA

TAROTPEDIA is a numerology and Tarot reader powered by AI.

Development

API

1. Install uv: https://docs.astral.sh/uv

2. Setup OPENAI_API_KEY in .env.

3. Install dependencies:

   uv sync --all-groups --all-extras

4. Start the server:

   make api

5. (Optional) Start the streamlit for UI development:

   make ui

Documentation as Code

This API documentation is generated using mkdocs-material and mkdocstrings for docs-as-code.

In your codebase, you can add the mkdocs markdown below the Python class, func,...

A markdown file is need to reference to the function with syntax ::: {path_to_python_file}.{function_name}. Then mkdocs will generate the API documentation for you.

Contribute

Please fork this repo and create a pull request, I will thank you later. This is my hobby project and I hope it can help your hobbies too.

License

This project is released under the CC0 1.0 Universal license.