This is a draft pet project for testing Generative AI on different software engineering tasks. It is planned to evolve and grow over time. Specifically, this repo will be a Python & FastAPI playground.
The application's legend is based on the sports-hub application description from the following repo: Sports-Hub.
- Docker
- Docker Compose
The mentioned dependencies can be installed using the official documentation here. Read more about alternatives to Docker here.
To run the web application with the React front-end, clone the following repositories within the same folder:
git clone git@github.com:dark-side/sports_hub_python_skeleton.git
git clone git@github.com:dark-side/sports_hub_react_skeleton.git
git clone git@github.com:dark-side/api_docs_genai_playground.gitAll commands should be run from the sports_hub_python_skeleton directory.
Copy the .env.example file to .env in the root of the project directory:
cp .env.example .envUpdate the .env file with your local development credentials and secrets. Make sure not to commit this .env file to version control.
Navigate to the back-end application directory and run (-d for detached mode to run in the background):
docker compose up -dRun docker ps and copy the backend application container ID. Then, connect to the container with the following command:
docker exec -ti <CONTAINER ID> /bin/bashInside the backend application container, run the following command to reset the database if needed:
uv run alembic downgrade f2ee1e269afc
uv run alembic upgrade headWhile running the App on Windows 11 using WSL, you may face issues related to Unix-style line endings (especially if you are storing the project(s) under the host machine filesystem, not the WSL one (e.g., the project is cloned to the disc c: or any other disk you have instead of being cloned to the WSL filesystem). Working within the WSL filesystem is a best practice when developing on Windows, as it helps prevent line ending and permission issues that can arise when using the Windows filesystem. I'm just reminding you that this will save you time and headaches for future projects.
If you are still reading this, please ensure your host machine converts related script(s) to Unix-style line endings.
# Install dos2unix if not already installed
sudo apt-get install dos2unix
# Convert all files in the project directory to Unix-style line endings
find . -type f -exec dos2unix {} \;
# Convert one file (example)
dos2unix bin/docker-entrypointAlso, if you face issues with bin directory files not being executable, you can fix it with the following commands:
# check current permissions on the file
ls -l bin/docker-entrypoint
# ensure the file is executable
chmod +x bin/docker-entrypointTo access the application in a browser locally, open the following URL:
- Mac, Linux -
http://localhost:3000/ - Windows -
http://127.0.0.1:3000/
- Python 3.12 (See .python-version)
- Install uv Package Manager
- Create virtual environment and install dependencies:
uv sync- (First run) Make sure DB is up
docker compose up postgres -d --wait- (First run) Apply latest DB schema:
uv run alembic upgrade head- Run the application:
uv run python -m api.main
- Open Open API Documentation: http://localhost:3002/docs
Make sure DB is up and running:
docker compose up postgres -d --waitTo run tests, run the following command:
uv run pytest tests/uv run ruff format api/ tests/
uv run ruff check api/ tests/ --fixLicensed under either of
Just to let you know, at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in your work, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
Should you have any suggestions, please create an Issue for this repository