Webtile

A Simple Markdown Website Content Manager

Table of Contents

• Introduction
• Features
• Installation
• Usage
• Configuration
• Contributing
• License

Introduction

Welcome to Webtile, a minimalistic and mobile-friendly blog and community platform built with Flask. Webtile allows you to showcase blog posts, feature articles, and community resources with ease.

Features

• 📝 Blog: Create and manage blog posts written in Markdown.
• 🌟 Featured Post: Highlight a featured blog post on the main blog page.
• 🏘️ Community: List and describe various organizations and resources in a dedicated community page.
• 🌐 Mobile-Friendly: Responsive design for seamless usage on both desktop and mobile devices.
• 📂 Markdown Support: Write posts in Markdown and render them beautifully.
• 🔍 Logging: Comprehensive request and error logging.

Installation

Prerequisites

• Python 3.6+
• Flask

Setup

1. Clone the Repository

git clone https://github.com/yourusername/webtile.git
cd webtile

2. Create a Virtual Environment

python3 -m venv .venv
source .venv/bin/activate

3. Install Dependencies

pip install -r requirements.txt

4. Set Environment Variables Create a .env file and set your environment variables as required by the Environment class in scripts/utils.py.

Usage

Running the App Locally

python launch.py -h
usage: launch.py [-h] [-v] [-e ENVIRONMENT]

Launch the webtile flask application

options:
  -h, --help            show this help message and exit
  -v, --verbose         Enable verbose output for debugging
  -e ENVIRONMENT, --environment ENVIRONMENT
                        Environment file name (default: .env)

Running with Gunicorn

For production environments:

gunicorn -w 4 -b 127.0.0.1:8000 launch:app

Configuration

• Logging: Configure logging settings in .env
• Featured Post: Set the filename of the featured post in the environment variable FEATURED_POST.

Contributing

Contributions are welcome! Please fork this repository and submit pull requests.

Steps to Contribute

1. Fork the repository.
2. Create a new branch (git checkout -b feature-branch).
3. Make your changes.
4. Commit your changes (git commit -m 'Add some feature').
5. Push to the branch (git push origin feature-branch).
6. Open a pull request.

License

GNU General Public License v3.0

---

Made with ❤️ by Kodama Chameleon

🚨 Disclaimer: KodamaChameleon.com is currently in vendor lock and does not implement webtile. Possibly at some point in the future.