{"id":18868312,"url":"https://github.com/buuntu/stockfish-chess","last_synced_at":"2025-07-08T01:09:50.159Z","repository":{"id":38962052,"uuid":"242467572","full_name":"Buuntu/stockfish-chess","owner":"Buuntu","description":"Chess application using FastAPI, React, and Stockfish engine","archived":false,"fork":false,"pushed_at":"2024-11-10T01:13:17.000Z","size":425,"stargazers_count":21,"open_issues_count":11,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-21T15:24:26.727Z","etag":null,"topics":["chessjs","fastapi","react","stockfish","websockets"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Buuntu.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2020-02-23T06:20:48.000Z","updated_at":"2025-04-06T07:34:15.000Z","dependencies_parsed_at":"2025-04-14T15:08:37.735Z","dependency_job_id":"ee5b1225-a5ab-4b7d-b6b1-f9947abc5d68","html_url":"https://github.com/Buuntu/stockfish-chess","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Buuntu/stockfish-chess","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Buuntu%2Fstockfish-chess","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Buuntu%2Fstockfish-chess/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Buuntu%2Fstockfish-chess/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Buuntu%2Fstockfish-chess/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Buuntu","download_url":"https://codeload.github.com/Buuntu/stockfish-chess/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Buuntu%2Fstockfish-chess/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259981477,"owners_count":22941149,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["chessjs","fastapi","react","stockfish","websockets"],"created_at":"2024-11-08T05:13:22.076Z","updated_at":"2025-06-15T13:08:09.473Z","avatar_url":"https://github.com/Buuntu.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Stockfish Chess [![tests](https://github.com/Buuntu/stockfish-chess/actions/workflows/main.yml/badge.svg)](https://github.com/Buuntu/stockfish-chess/actions/workflows/main.yml)\n\nA chess game using FastAPI and React to play against the Stockfish engine.\n\n![chess board](img/board.png)\n\n## Features\n\n- **FastAPI** with Python 3.8\n- **React 16** with Typescript\n- Postgresql\n- SqlAlchemy with Alembic for migrations\n- Pytest for backend tests\n- Jest for frontend tests\n- Prettier/Black for linting\n- Docker compose for easier development\n- Nginx as a reverse proxy to allow backend and frontend on the same port\n\n## Development\n\nThe only dependencies for this project should be docker and docker-compose.\n\n### Quick Start\n\nStarting the project with hot-reloading enabled\n(the first time it will take a while):\n\n```bash\ndocker-compose up -d\n```\n\nTo run the alembic migrations (for the users table):\n\n```bash\ndocker-compose run --rm backend alembic upgrade head\n```\n\nAnd navigate to http://localhost:8000\n\n_Note: If you see an Nginx error at first with a `502: Bad Gateway` page, you may have to wait for webpack to build the development server (the nginx container builds much more quickly)._\n\nAuto-generated docs will be at\nhttp://localhost:8000/api/docs\n\n### Rebuilding containers:\n\n```\ndocker-compose build\n```\n\n### Restarting containers:\n\n```\ndocker-compose restart\n```\n\n### Bringing containers down:\n\n```\ndocker-compose down\n```\n\n### Frontend Development\n\nAlternatively to running inside docker, it can sometimes be easier\nto use npm directly for quicker reloading. To run using npm:\n\n```\ncd frontend\nnpm install\nnpm start\n```\n\nThis should redirect you to http://localhost:3000\n\n### Frontend Tests\n\n```\ncd frontend\nnpm install\nnpm test\n```\n\n## Migrations\n\nMigrations are run using alembic. To run all migrations:\n\n```\ndocker-compose run --rm backend alembic upgrade head\n```\n\nTo create a new migration:\n\n```\nalembic revision -m \"create users table\"\n```\n\nAnd fill in `upgrade` and `downgrade` methods. For more information see\n[Alembic's official documentation](https://alembic.sqlalchemy.org/en/latest/tutorial.html#create-a-migration-script).\n\n## Testing\n\nThere is a helper script for both frontend and backend tests:\n\n```\n./scripts/test.sh\n```\n\n### Backend Tests\n\n```\ndocker-compose run backend pytest\n```\n\nany arguments to pytest can also be passed after this command\n\n### Frontend Tests\n\n```\ndocker-compose run frontend test\n```\n\nThis is the same as running npm test from within the frontend directory\n\n## Logging\n\n```\ndocker-compose logs\n```\n\nOr for a specific service:\n\n```\ndocker-compose logs -f name_of_service # frontend|backend|db\n```\n\n## Project Layout\n\n```\nbackend\n└── app\n    ├── alembic\n    │   └── versions # where migrations are located\n    ├── api\n    │   └── api_v1\n    │       └── endpoints\n    ├── core    # config\n    ├── db      # db models\n    ├── tests   # pytest\n    └── main.py # entrypoint to backend\n\nfrontend\n└── public\n└── src\n    ├── components\n    │   └── Home.tsx\n    ├── config\n    │   └── index.tsx   # constants\n    ├── __tests__\n    │   └── test_home.tsx\n    ├── index.tsx   # entrypoint\n    └── App.tsx     # handles routing\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbuuntu%2Fstockfish-chess","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbuuntu%2Fstockfish-chess","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbuuntu%2Fstockfish-chess/lists"}