PrivateCoffee/small
4
0
Fork 1
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
No description
3 commits 1 branch 0 tags 81 KiB
Python 48.4%
HTML 32.1%
CSS 15.4%
Dockerfile 2.1%
Shell 2%
Find a file
Kumi b6c7277535
fix(home.html): ensure full URL string for consistency 
Updated the instructional text to replace "medium.com" with the full "https://medium.com/" URL to avoid potential confusion and ensure users receive a clear and consistent guideline. This should enhance the user experience by providing explicit directions.
2024-09-19 14:18:58 +02:00
src/small fix(home.html): ensure full URL string for consistency 2024-09-19 14:18:58 +02:00
.gitignore feat: initialize project structure for Small 2024-09-19 09:14:05 +02:00
LICENSE feat: initialize project structure for Small 2024-09-19 09:14:05 +02:00
pyproject.toml feat: initialize project structure for Small 2024-09-19 09:14:05 +02:00
README.md feat: initialize project structure for Small 2024-09-19 09:14:05 +02:00

README.md

Small

Small is an alternative frontend for Medium articles, built with Flask. It allows users to read Medium articles without the clutter and distractions of the original Medium interface.

Features

  • Clean, minimalist interface for reading Medium articles
  • Fetches article content directly from Medium's GraphQL API
  • Parses and displays article content, including text and basic formatting
  • Responsive design for comfortable reading on various devices

Installation

  1. Clone the repository:

    git clone https://git.private.coffee/PrivateCoffee/small.git
cd small

  2. Create a virtual environment and activate it:

    python -m venv venv
source venv/bin/activate

  3. Install the package:

    pip install .

Usage

  1. Start the Flask development server:

    small

  2. Open your web browser and navigate to http://localhost:5000

  3. To read a Medium article, replace https://medium.com in the article's URL with http://localhost:5000

    For example:

    • Original URL: https://medium.com/@username/article-title-123abc
    • Small URL: http://localhost:5000/@username/article-title-123abc

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/AmazingFeature)
  3. Commit your changes (git commit -m 'Add some AmazingFeature')
  4. Push to the branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

  • Inspired by the Scribe project built with Crystal and Lucky
  • Thanks to Medium for providing the content through their API

Disclaimer

This project is not affiliated with, endorsed, or sponsored by Medium. It's an independent project created to provide an alternative reading experience for Medium content.