{"id":16931308,"url":"https://github.com/pacso/chessmate","last_synced_at":"2026-04-20T05:06:50.161Z","repository":{"id":189173079,"uuid":"680188285","full_name":"pacso/chessmate","owner":"pacso","description":null,"archived":false,"fork":false,"pushed_at":"2023-08-24T21:58:17.000Z","size":20,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-02T00:17:10.565Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Jupyter Notebook","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pacso.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2023-08-18T14:55:25.000Z","updated_at":"2023-08-24T09:15:02.000Z","dependencies_parsed_at":"2023-08-18T16:28:05.834Z","dependency_job_id":null,"html_url":"https://github.com/pacso/chessmate","commit_stats":null,"previous_names":["pacso/chessmate"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pacso%2Fchessmate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pacso%2Fchessmate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pacso%2Fchessmate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pacso%2Fchessmate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pacso","download_url":"https://codeload.github.com/pacso/chessmate/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244730317,"owners_count":20500416,"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":[],"created_at":"2024-10-13T20:43:43.201Z","updated_at":"2026-04-20T05:06:45.128Z","avatar_url":"https://github.com/pacso.png","language":"Jupyter Notebook","funding_links":[],"categories":[],"sub_categories":[],"readme":"# chessmate\n\nThis repository contains a Docker Compose setup for running Jupyter Notebooks. It allows you to quickly and reliably start a Jupyter environment without needing to install Jupyter and its dependencies on your local machine.\n\n## Prerequisites\n\n- **Docker**: Ensure you have Docker installed on your machine. If not, download and install Docker from [Docker's official website](https://www.docker.com/get-started).\n  \n- **Docker Compose**: Comes pre-packaged with Docker Desktop for Windows and Mac. If you're on Linux or need to install separately, follow the instructions [here](https://docs.docker.com/compose/install/).\n\n## Getting Started\n\n1. **Clone the Repository:**\n\n```\ngit clone https://github.com/pacso/chessmate.git\ncd chessmate/\n```\n\n2. **Using Docker Compose to Run Jupyter Notebook:**\n\n```\ndocker-compose up\n```\n\n   This command:\n\n   - Sets up a container with Jupyter Notebook.\n   - Maps port `8888` inside the container to port `8888` on your local machine.\n   - Mounts the directory specified in `docker-compose.yml` to `/home/jovyan/work` inside the container. This ensures that you can see and save your work on your local machine.\n\n3. **Access Jupyter Notebook:**\n\n   After the command, Docker will provide a URL to access Jupyter Notebook. It should look like this:\n\n```\nhttp://127.0.0.1:8888/?token=\u003csome-token\u003e\n```\n\n   Copy and paste this URL into your web browser to access Jupyter Notebook.\n\n## Using the Jupyter Environment\n\n- The `chessmate` directory inside Jupyter corresponds to the directory defined in the `docker-compose.yml`.\n- Any notebooks or files you create and save inside the `chessmate` directory in Jupyter will be saved to your local directory.\n- To install additional Python packages inside your Jupyter environment, you can add them to the Dockerfile and rebuild using `docker-compose build`.\n\n## Stopping the Jupyter Container\n\nTo stop the Jupyter server and the container:\n\n1. In your terminal, press `Ctrl + C`.\n2. Optionally, you can bring down the Docker Compose services:\n\n```\ndocker-compose down\n```\n\n## Contributing\n\nIf you'd like to contribute, please fork the repository, make your changes, and create a pull request. We'd love to merge in your changes!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpacso%2Fchessmate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpacso%2Fchessmate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpacso%2Fchessmate/lists"}