Fix deployment and rewrite readme

[5hojib]

Summary by Sourcery

Rewrite the README for better clarity and update the deployment script to fix the Heroku team name variable and use the latest Heroku deploy action version.

Deployment:

• Fix the deployment script by correcting the Heroku team name variable and updating the Heroku deploy action version.

Documentation:

• Rewrite the README to improve clarity and provide detailed deployment instructions for Heroku.

[sourcery-ai]

Reviewer's Guide by Sourcery

This PR focuses on improving deployment configuration and documentation. The changes include a comprehensive rewrite of the README.md with better formatting and clearer instructions, updates to the GitHub Actions workflow for Heroku deployment, and the addition of Docker and dependency configuration files.

Class diagram for deployment configuration

classDiagram
    class GitHubActions {
        +string HEROKU_EMAIL
        +string HEROKU_TEAM_NAME
        +string BOT_TOKEN
        +string OWNER_ID
        +string DATABASE_URL
        +string TELEGRAM_API
        +string TELEGRAM_HASH
    }
    class Dockerfile {
        +string FROM
        +string WORKDIR
        +string COPY
        +string RUN
        +string CMD
    }
    class Requirements {
        +list dependencies
    }
    GitHubActions --> Dockerfile : uses
    Dockerfile --> Requirements : installs

Loading

File-Level Changes

Change	Details	Files
Restructured and enhanced documentation with improved formatting and clarity	Added clear section headers with visual separators Rewrote feature descriptions to be more professional and detailed Expanded deployment instructions with step-by-step guidance Enhanced contributing section with specific guidelines Updated acknowledgements with proper repository links	README.md
Improved GitHub Actions workflow for Heroku deployment	Renamed HK_TEAM_NAME to HEROKU_TEAM_NAME for consistency Added cleanup step to remove unnecessary directories and files Updated Heroku deploy action version to v2 Removed hardcoded deploy branch reference	.github/workflows/deploy.yml
Added Docker and dependency configuration	Created Dockerfile using base image '5hojib/aeon:latest' Added comprehensive requirements.txt with all necessary Python dependencies Included sample configuration template	Dockerfile requirements.txt sample_config.env

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time. You can also use
  this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey @5hojib - I've reviewed your changes and found some issues that need to be addressed.

Blocking issues:

• Avoid using --break-system-packages as it can lead to system instability (link)

Overall Comments:

• Consider using a specific version tag instead of 'latest' in the Dockerfile base image to ensure consistent and reproducible builds

Here's what I looked at during the review

• 🟢 General issues: all looks good
• 🔴 Security: 1 blocking issue
• 🟢 Testing: all looks good
• 🟢 Complexity: all looks good
• 🟢 Documentation: all looks good

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[sourcery-ai]

🚨 issue (security): Avoid using --break-system-packages as it can lead to system instability

This flag allows pip to modify system Python packages which could break system tools. Consider using a virtual environment or building a multi-stage Docker image instead.