/Chess.com-Game-Readme

Svg of your most recent game on Chess.com for GitHub Readme

Primary LanguageJupyter NotebookMIT LicenseMIT


Chess.com-Game-Readme

📍 Show off your most recent game on Chess.com through your GitHub readme

🚀 Developed with the software and tools below.

click chess markdown frozenlist

📚 Table of Contents

📍Overview

The Chess.com-Game-Readme GitHub project allows you to display your most recent chess.com game on your github readme page, sharing with everyone how your games are going.

⚙️ Project Structure

repo
├── app.py
├── LICENSE
├── __pycache__
│   ├── app.cpython-311.pyc
│   └── app.cpython-39.pyc
├── README.md
├── requirements.txt
└── vercel.json

1 directory, 7 files

🚀 Getting Started

✅ Prerequisites

Before you begin, ensure that you have the following prerequisites installed:

Register an account on vercel

💻 Installation

  1. Fork this repo
Screenshot 2023-06-10 at 04 41 18
  1. Go to vercel, create a project using the forked github repo
Screenshot 2023-06-10 at 04 41 30 Screenshot 2023-06-10 at 04 41 41
  1. Provide environment variable: username
Screenshot 2023-06-10 at 04 42 08
  1. Deploy and enjoy

🤖 Using Chess.com-Game-Readme

<img src="link-to-your-vercel-app/?">

🤝 Contributing

Contributions are always welcome! Please follow these steps:

  1. Fork the project repository. This creates a copy of the project on your account that you can modify without affecting the original project.
  2. Clone the forked repository to your local machine using a Git client like Git or GitHub Desktop.
  3. Create a new branch with a descriptive name (e.g., new-feature-branch or bugfix-issue-123).
git checkout -b new-feature-branch
  1. Make changes to the project's codebase.
  2. Commit your changes to your local branch with a clear commit message that explains the changes you've made.
git commit -m 'Implemented new feature.'
  1. Push your changes to your forked repository on GitHub using the following command
git push origin new-feature-branch
  1. Create a pull request to the original repository. Open a new pull request to the original project repository. In the pull request, describe the changes you've made and why they're necessary. The project maintainers will review your changes and provide feedback or merge them into the main branch.

🪪 License

This project is licensed under the MIT License. See the LICENSE file for additional info.

[📌 INSERT-DESCRIPTION]