Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alextkdev/myflaskproject
https://github.com/alextkdev/myflaskproject
Last synced: 1 day ago
JSON representation
- Host: GitHub
- URL: https://github.com/alextkdev/myflaskproject
- Owner: AlexTkDev
- Created: 2024-05-01T11:29:57.000Z (7 months ago)
- Default Branch: master
- Last Pushed: 2024-08-06T09:01:55.000Z (3 months ago)
- Last Synced: 2024-08-06T10:52:20.537Z (3 months ago)
- Language: HTML
- Size: 19.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Blog Documentation on Flask
## Project Description
This project is a blog developed using Flask. It allows users to view posts, add new entries, and leave comments.
## Project Structure
```
myblog/
├── instance/
│ ├── __init__.py
│ └── config.py
├── templates/
│ ├── base.html
│ ├── index.html
│ ├── post.html
│ └── new_post.html
├── app.py
├── requirements.txt
└── README.md
```
### Directory and File Descriptions
- `instance/`: Configuration files.
- `__init__.py`: Package initialization.
- `config.py`: Application configuration.
- `templates/`: HTML templates.
- `base.html`: Common page structure.
- `index.html`: Home page.
- `post.html`: Post page.
- `new_post.html`: New post page.
- `app.py`: Main application file.
- `requirements.txt`: Project dependencies.
## Installation and Running the Project
### Prerequisites
- Python 3.8+
- pip
### Cloning the Repository
```bash
git clone https://github.com/AlexTkDev/MyFlaskProject.git
cd myblog
```
### Installing Dependencies
```bash
pip install -r requirements.txt
```
### Running the Application
```bash
flask run
```
The application will be available at [http://127.0.0.1:5000](http://127.0.0.1:5000).
## Using Bootstrap 5
Bootstrap 5 is used for styling the pages, included through `base.html`.
## Application Routes
### Home Page
Route: `/`
Description: Displays all posts.
### Post Page
Route: `/post/`
Description: Displays the selected post.
### New Post
Route: `/new`
Description: Form for adding a new post.
## Conclusion
This project is a simple blog on Flask that can be extended and modified to suit your needs. Flask provides flexibility and ease of development, and using templates and Bootstrap 5 allows for creating modern and responsive interfaces.
***
# Документация к блогу на Flask
## Описание проекта
Этот проект представляет собой блог, разработанный с использованием Flask. Он позволяет пользователям просматривать посты, добавлять новые записи и оставлять комментарии.
## Структура проекта
```
myblog/
├── instance/
│ ├── __init__.py
│ └── config.py
├── templates/
│ ├── base.html
│ ├── index.html
│ ├── post.html
│ └── new_post.html
├── app.py
├── requirements.txt
└── README.md
```
### Описание директорий и файлов
- `instance/`: Конфигурационные файлы.
- `__init__.py`: Инициализация пакета.
- `config.py`: Конфигурация приложения.
- `templates/`: HTML-шаблоны.
- `base.html`: Общая структура страниц.
- `index.html`: Главная страница.
- `post.html`: Страница поста.
- `new_post.html`: Страница добавления нового поста.
- `app.py`: Основной файл приложения.
- `requirements.txt`: Зависимости проекта.
## Установка и запуск проекта
### Предварительные требования
- Python 3.8+
- pip
### Клонирование репозитория
```bash
git clone https://github.com/AlexTkDev/MyFlaskProject.git
cd myblog
```
### Установка зависимостей
```bash
pip install -r requirements.txt
```
### Запуск приложения
```bash
flask run
```
Приложение будет доступно по адресу [http://127.0.0.1:5000](http://127.0.0.1:5000).
## Использование Bootstrap 5
Для стилизации страниц используется Bootstrap 5, подключенный через `base.html`.
## Маршруты приложения
### Главная страница
Маршрут: `/`
Описание: Отображает все посты.
### Страница поста
Маршрут: `/post/`
Описание: Отображает выбранный пост.
### Новая запись
Маршрут: `/new`
Описание: Форма для добавления нового поста.
## Заключение
Этот проект представляет собой простой блог на Flask, который можно расширять и модифицировать под ваши нужды. Flask обеспечивает гибкость и легкость разработки, а использование шаблонов и Bootstrap 5 позволяет создавать современные и отзывчивые интерфейсы.