Skip to content

Latest commit

 

History

History
132 lines (99 loc) · 6.29 KB

README.md

File metadata and controls

132 lines (99 loc) · 6.29 KB
Raw

Chess.com-ReadME


Chess.com-Readme

📍 Share your Chess.com Elo on your GitHub Readme page

🚀 Developed with the software and tools below.

click txt frozenlist itsdangerous chess.com

📚 Table of Contents

📍Overview

The Chess.com-Readme project creates a badge for your github readme with your chess.com elo rating on it.

⚙️ Project Structure

repo
├── app.py
├── LICENSE
├── README.md
├── requirements.txt
├── templates
│   └── card.html.j2
└── vercel.json

2 directories, 6 files

💻 Modules

Root
File Summary Module
app.py This code creates a web application using Flask that generates a card displaying a user 's rating on Chess.com for a specified time control . It uses the chessdotcom library to access the user 's stats and the dotenv library to access environment app.py
Templates
File Summary Module
card.html.j2 This code creates an SVG graphic with two rectangles , one in # 555 and one in # 007ec6 , and two text elements displaying the values of the variables " time_control " and " elo " . The graphic is 139x20 templates/card.html.j2

🚀 Getting Started

✅ Prerequisites

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

Register for a vercel account

💻 Installation

  1. Fork this repo
Screenshot 2023-06-10 at 04 41 18
  1. Go to vercel and create a new project using the forked repo
Screenshot 2023-06-10 at 04 41 30 Screenshot 2023-06-10 at 04 41 41
  1. Specify the environment variables username and time_control, time_control has options chess_bullet, chess_blitz and chess_rapid, if not specified, the highest rating in any time control will be used.
Screenshot 2023-06-10 at 04 42 08

🤖 Using Chess.com-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.