An open API service indexing awesome lists of open source software.

https://github.com/sakhileln/flask-chronicles

A simple and lightweight blog built with Flask. Showcasing posts on coding, tech, and personal projects. Open-source and ready to deploy! ⚗️
https://github.com/sakhileln/flask-chronicles

babel ci-cd database elasticsearch flask flask-sqlalchemy logging migration sqlite3

Last synced: 4 months ago
JSON representation

A simple and lightweight blog built with Flask. Showcasing posts on coding, tech, and personal projects. Open-source and ready to deploy! ⚗️

Awesome Lists containing this project

README

          

# Simple Flask Blog ⚗️
This is a simple blog built with Flask. It allows you to create, edit, and view posts, showcasing basic web development concepts like routing, templates, and forms. This project serves as an easy-to-follow example of a lightweight blog app, perfect for learning or personal projects.

## Table of Contents
- [Features](#features)
- [Requirements](#requirements)
- [How to Run](#how-to-run)
- [Usage](#usage)
- [Contributing](#contributing)
- [Contact](#contact)

## Features
- **Post Creation**: Add new blog posts via a simple form.
- **Post Display**: View all published posts in a clean, minimal layout.
- **Post Editing**: Edit or update existing posts.
- **Post Deletion**: Remove posts when no longer needed.
- **Responsive Design**: Mobile-friendly UI for a smooth experience across devices.

## Requirements
- Python 3.x
- Flask (`pip install Flask`)
- Jinja2 (comes with Flask)
- SQLite (included with Python)

## How to Run
1. Clone or download the repository.
2. Navigate to the project directory:
```bash
cd Flask-Chronicles
```
3. Create a virtual environment:
```bash
python -m venv venv

# Activate the virtual environment
source venv/bin/activate
```
4. Install dependencies:
```bash
pip install -r requirements.txt
```
5. Run the app:
```bash
python app.py
```
6. Navigate to http://127.0.0.1:5000/ in your browser to view the blog.

## Usage
- The app includes simple routes for viewing, creating, and managing posts.
- The home page will show a list of posts.
- You can add, edit, or delete posts through the admin interface.
- The posts are saved in an SQLite database (blog.db).

## Contributing
Contributions are welcome! If you have ideas for improvements or new features, please fork the repository and submit a pull request.
1. Fork the repository
2. Create your feature branch:
```bash
git checkout -b feature/YourFeature
```
3. Commit your changes:
```bash
git commit -m "Add feature"
```
4. Push to the branch:
```bash
git push origin feature/YourFeature
```
5. Open a pull request.

## Contact
- Sakhile III
- [LinkedIn Profile](https://www.linkedin.com/in/sakhile-ndlazi)
- [GitHub Profile](https://github.com/sakhileln)