Призначення шаблону

Шаблон README для хакатонного проєкту — це структура, яка допомагає швидко оформити репозиторій так, щоб журі та інші учасники одразу зрозуміли суть вашого рішення. На хакатоні час обмежений, і розписувати документацію з нуля недоцільно. Шаблон дає готовий каркас: ви заповнюєте конкретні поля, а формат і порядок блоків вже продумані.

Ресурс орієнтований на команди, які розробляють на Solana та використовують Anchor, Rust або TypeScript-стеки. Він не замінює технічну документацію, а забезпечує мінімально достатній рівень опису для презентації проєкту.

Структура хакатонного README

Назва проєкту та one-liner

Перший рядок — назва проєкту. Одразу під нею — одне речення, яке пояснює, що саме робить продукт. Без вступів про «ми команда ентузіастів» та загальних фраз. Формула проста: хто користувач, яку проблему вирішує, як саме.

Далі — бейджі або короткі мітки: статус проєкту (MVP, прототип), хакатон, трек (DeFi, NFT, RWA тощо), використаний стек.

Технічний стек та архітектура

Блок містить перелік ключових технологій: мова смарт-контрактів (Rust), фреймворк (Anchor), клієнтська частина (React, Next.js), бібліотеки для взаємодії з Solana (@solana/web3.js, @coral-xyz/anchor). Для кожного елемента вказується версія — це допомагає журі та іншим розробникам зрозуміти контекст.

Архітектура описується стисло: які програми (programs) розгорнуті на ланцюжку, які PDA (Program Derived Address — похідні адреси програми) використовуються, де відбуваються CPI (Cross-Program Invocation — міжпрограмні виклики). Достатньо трьох-п’яти речень або простої діаграми текстовим форматом.

Інструкція запуску та демо

Журі має можливість запустити проєкт локально. Блок містить покрокову послідовність: клонування репозиторію, встановлення залежностей, налаштування змінних середовища (зокрема RPC-ендпоінт та ключі гаманців для локального тестування), збірка та розгортання смарт-контрактів, запуск фронтенду.

Якщо є розгорнуте демо — вказується посилання та тестові дані (гаманець з тестовими SOL, приклад транзакції). Якщо демо немає — це прямо вказується з поясненням причин (наприклад, залежність від специфічного RPC-провайдера).

Виклики та майбутні кроки

Чесний опис того, що не встигли реалізувати за час хакатону. Це не слабкість — а показ розуміння масштабу завдання. Формулювання конкретні: «не реалізовано індексування подій через Helius», «відсутня перевірка прав доступу адміністратора», «клієнт не обробляє помилки транзакцій».

Майбутні кроки — це логічне продовження: що б ви зробили наступні два тижні за умови фінансування або продовження роботи.

Порядок заповнення

  1. Скопіюйте структуру — перенесіть каркас шаблону до файлу README.md у корені репозиторію.
  2. Заповніть one-liner — це найважливіший блок. Якщо не можете сформулювати одне речення, поверніться до визначення проблеми.
  3. Вкажіть стек — перелічіть лише те, що реально використовуєте. Не додавайте технології «на майбутнє».
  4. Опишіть архітектуру — фокус на взаємодії між смарт-контрактами та клієнтом, а не на загальних принципах Solana.
  5. Напишіть інструкцію запуску — обов’язково перевірте її на чистій машині (не вашій робочій, де все вже налаштовано).
  6. Додайте виклики — перелічіть мінімум три речі, які не встигли або не змогли реалізувати.
  7. Відформатуйте — переконайтеся, що Markdown рендериться коректно на GitHub.

Обмеження шаблону

  • Шаблон не містить готових текстів — лише структуру та підказки щодо заповнення. Зміст ви формулюєте самостійно.
  • Він не замінює submission-чеклист хакатону. Перевірку відповідності вимогам організаторів виконуйте окремо — зокрема за допомогою робочого чек-листу submission для Solana-хакатону.
  • Шаблон не адаптовано під специфічні вимоги окремих хакатонів (Colosseum, Hyperdrive тощо) — їхні правила подавання можуть відрізнятися.
  • Він не містить блоків для юридичної інформації, ліцензування чи токеноміки — ці розділи виходять за межі хакатонного README.
  • Шаблон орієнтований на Solana-проєкти та не враховує специфіку інших ланцюжків.

Версія ресурсу

Ресурс «Шаблон README для хакатонного проєкту»: статична версія 1.0. Сторінка містить готовий текстовий шаблон і готова до практичного використання без очікування окремого інтерактивного інструмента. Остання редакційна перевірка: 2 серпня 2026 року.

Джерела