Шаблоны

НЕ ОБЯЗАТЕЛЬНОДЛЯ НОВИЧКОВ

Шаблоны

Шаблоны — это готовые структуры кода, конфигураций и файлов, которые позволяют начать работу над проектом без необходимости каждый раз заново изобретать базовые элементы. Они экономят время, снижают порог входа и помогают соблюдать стандарты сообщества. В этом разделе собраны минимальные, но полностью рабочие шаблоны для самых распространённых задач и технологий.

Минимальный SQL-запрос (CRUD)

CRUD — это четыре основные операции с данными: Create (создание), Read (чтение), Update (обновление), Delete (удаление). Ниже приведены примеры на языке SQL, совместимые с большинством реляционных СУБД.

-- Создание таблицы
CREATE TABLE users (
    id SERIAL PRIMARY KEY,
    name VARCHAR(100) NOT NULL,
    email VARCHAR(150) UNIQUE
);

-- Create: добавление записи
INSERT INTO users (name, email) VALUES ('Алиса', 'alice@example.com');

-- Read: выборка всех записей
SELECT * FROM users;

-- Read: выборка одной записи по условию
SELECT * FROM users WHERE id = 1;

-- Update: изменение записи
UPDATE users SET email = 'new_alice@example.com' WHERE id = 1;

-- Delete: удаление записи
DELETE FROM users WHERE id = 1;

Эти запросы можно использовать как отправную точку для работы с любой РСУБД — PostgreSQL, MySQL, SQLite, MS SQL Server и другими.

---

Минимальный .gitignore

Файл .gitignore указывает Git, какие файлы и директории не следует отслеживать. Это особенно важно для исключения временных, скомпилированных или локальных файлов.

# ОС
.DS_Store
Thumbs.db

# IDE
.vs/
.vscode/
.idea/
*.suo
*.user

# Логи и временные файлы
*.log
tmp/
temp/

# Зависимости и пакеты
node_modules/
venv/
__pycache__/
.env

# Скомпилированный код
*.exe
*.dll
*.class
*.jar
bin/
obj/

# Docker
.dockerignore

Этот шаблон подходит для большинства проектов на разных языках. Его можно расширять в зависимости от используемых технологий.

---

Минимальный README.md

Файл README.md — первое, что видит пользователь репозитория. Он должен кратко объяснять, что делает проект и как с ним работать.

# Название проекта

Краткое описание цели проекта.

## Установка

```bash
git clone https://github.com/ваш-проект.git
cd ваш-проект
npm install  # или pip install -r requirements.txt и т.д.

Использование

Опишите, как запустить или использовать проект.

---

Минимальная лицензия MIT (LICENSE)

Лицензия MIT — одна из самых простых и популярных открытых лицензий. Она разрешает использовать, копировать, изменять и распространять код при условии сохранения уведомления об авторских правах.

MIT License

Copyright (c) [год] [имя автора]

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated Документация files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Замените [год] и [имя автора] на актуальные значения.

---

Минимальная программа на C#

Простейшее консольное приложение на C# с использованием современного синтаксиса (top-level statements, доступного с .NET 6+).

// Program.cs
Console.WriteLine("Привет, мир!");

Если используется более старая версия .NET, требуется полная форма:

// Program.cs
using Система;

class Program
{
    static void Main()
    {
        Console.WriteLine("Привет, мир!");
    }
}

Этот шаблон подходит для начала любого консольного проекта на C#.

---

Минимальная программа на Java

Простейший исполняемый класс на Java.

// Main.java
public class Main {
    public static void main(String[] args) {
        System.out.println("Привет, мир!");
    }
}

Файл должен называться точно так же, как и публичный класс (Main.java). Компиляция и запуск:

javac Main.java
java Main

---

Минимальный HTML-документ

Базовая структура веб-страницы, соответствующая стандарту HTML5.

<!DOCTYPE html>
<html lang="ru">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>Заголовок страницы</title>
</head>
<body>
    <h1>Привет, мир!</h1>
</body>
</html>

Этот шаблон включает все необходимые метатеги для корректного отображения на разных устройствах.

---

Минимальный XML-документ

XML часто используется для конфигураций, обмена данными и хранения структурированной информации.

<?xml version="1.0" encoding="UTF-8"?>
<root>
    <item id="1">Пример данных</item>
</root>

Обязательно указывать декларацию XML и корневой элемент.

---

Минимальный JSON-документ

JSON — стандартный формат для передачи данных между клиентом и сервером.

{
  "message": "Привет, мир!",
  "version": 1
}

Валидный JSON всегда начинается с объекта {} или массива [].

---

Минимальный Python-скрипт с Tkinter

Tkinter — встроенная библиотека для создания графических интерфейсов в Python.

# gui.py
import tkinter as tk

root = tk.Tk()
root.title("Моё окно")
label = tk.Label(root, text="Привет, мир!")
label.pack(padx=20, pady=20)
root.mainloop()

Запуск: python gui.py. Откроется окно с надписью.

---

Минимальный Python-скрипт с Turtle

Turtle — модуль для обучения программированию через рисование.

# turtle_draw.py
import turtle

screen = turtle.Screen()
t = turtle.Turtle()
t.forward(100)
t.left(90)
t.forward(100)
screen.exitonclick()

Этот код рисует угол (две стороны квадрата) и завершает работу по клику.

---

Минимальный Dockerfile

Dockerfile описывает, как собрать образ контейнера.

# Dockerfile
FROM alpine:latest
RUN echo "Привет из контейнера!"
CMD ["echo", "Запущено!"]

Для Python-приложения:

FROM python:3.11-slim
WORKDIR /app
COPY . .
RUN pip install -r requirements.txt
CMD ["python", "app.py"]

---

Минимальный package.json (Node.js)

Файл описания проекта в экосистеме Node.js.

{
  "name": "my-project",
  "version": "1.0.0",
  "description": "Минимальный проект",
  "main": "index.js",
  "scripts": {
    "start": "node index.js"
  },
  "license": "MIT"
}

После создания можно запускать: npm start.

---

Минимальный набор файлов для C#-проекта (.NET)

Для консольного приложения на .NET 6+ достаточно двух файлов:

MyApp/
├── MyApp.csproj
└── Program.cs

MyApp.csproj:

<Project Sdk="Microsoft.NET.Sdk">
  <PropertyGroup>
    <OutputType>Exe</OutputType>
    <TargetFramework>net8.0</TargetFramework>
  </PropertyGroup>
</Project>

Program.cs:

Console.WriteLine("Привет из .NET!");

Сборка: dotnet build, запуск: dotnet run.

---

Минимальный набор файлов для PHP-проекта

Для простого веб-приложения:

my-php-app/
├── index.php
└── .gitignore

index.php:

<?php
echo "<h1>Привет, мир!</h1>";
?>

Запуск через встроенный сервер: php -S localhost:8000.

---

Минимальный набор файлов для JavaScript-проекта (фронтенд)

my-js-app/
├── index.html
├── script.js
└── styles.css

index.html:

<!DOCTYPE html>
<html>
<head><title>JS App</title></head>
<body>
  <script src="script.js"></script>
</body>
</html>

script.js:

alert("Привет из JavaScript!");

---

Шаблон MVP на ASP.NET Core

MVP (Model-View-Presenter) — архитектурный шаблон, подходящий для веб-приложений. В ASP.NET Core чаще используется MVC, но MVP можно реализовать вручную.

Структура:

MyMvpApp/
├── Models/
│   └── MessageModel.cs
├── Views/
│   └── Home/
│       └── Index.cshtml
├── Presenters/
│   └── HomePresenter.cs
└── Controllers/
    └── HomeController.cs

MessageModel.cs:

public class MessageModel
{
    public string Text { get; set; } = "Привет из модели!";
}

HomePresenter.cs:

public class HomePresenter
{
    public MessageModel GetMessage() => new MessageModel();
}

HomeController.cs:

public class HomeController : Controller
{
    public IActionResult Index()
    {
        var presenter = new HomePresenter();
        var model = presenter.GetMessage();
        return View(model);
    }
}

Index.cshtml:

@model MessageModel
<h1>@Model.Text</h1>

Это минимальная реализация MVP-логики в ASP.NET Core.

---