This commit is contained in:
114
README.md
114
README.md
@@ -1,4 +1,4 @@
|
||||
# 🐱 CatLink - Персональные страницы ссылок# 🐱 CatLink - Персональные страницы ссылок
|
||||
# 🐱 CatLink - Персональные страницы ссылок
|
||||
|
||||
|
||||
|
||||
@@ -12,59 +12,43 @@
|
||||
|
||||
|
||||
|
||||
**CatLink** - современная платформа для создания красивых персональных страниц со всеми важными ссылками в одном месте. Альтернатива Linktree с открытым исходным кодом.**CatLink** - современная платформа для создания красивых персональных страниц со всеми важными ссылками в одном месте. Альтернатива Linktree с открытым исходным кодом.
|
||||
**CatLink** - современная платформа для создания красивых персональных страниц со всеми важными ссылками в одном месте. Альтернатива Linktree с открытым исходным кодом.
|
||||
|
||||
|
||||
|
||||
## ✨ Возможности## ✨ Возможности
|
||||
## ✨ Возможности
|
||||
|
||||
|
||||
|
||||
- 🎨 **Множество макетов**: список, сетка, компактная сетка, журнальная верстка- 🎨 **Множество макетов**: список, сетка, компактная сетка, журнальная верстка
|
||||
- 🎨 **Множество макетов**: список, сетка, компактная сетка, журнальная верстка
|
||||
|
||||
- 🎭 **Персонализация**: настройка цветов, фонов, иконок- 🎭 **Персонализация**: настройка цветов, фонов, иконок
|
||||
- 🎭 **Персонализация**: настройка цветов, фонов, иконок
|
||||
- 📱 **Адаптивный дизайн**: отлично работает на всех устройствах
|
||||
- 🔐 **Система аутентификации**: регистрация и управление профилем
|
||||
|
||||
- 📱 **Адаптивный дизайн**: отлично работает на всех устройствах- 📱 **Адаптивный дизайн**: отлично работает на всех устройствах
|
||||
- 📊 **Группировка ссылок**: организация ссылок по категориям
|
||||
- 🌐 **SEO-оптимизация**: дружественные URL и метатеги
|
||||
- 🚀 **Высокая производительность**: быстрая загрузка и отзывчивость
|
||||
- 🐳 **Docker Ready**: простой деплой с помощью контейнеров
|
||||
## 🚀 Быстрый старт
|
||||
|
||||
- 🔐 **Система аутентификации**: регистрация и управление профилем- 🔐 **Система аутентификации**: регистрация и управление профилем
|
||||
|
||||
- 📊 **Группировка ссылок**: организация ссылок по категориям- 📊 **Группировка ссылок**: организация ссылок по категориям
|
||||
### Требования
|
||||
|
||||
- 🌐 **SEO-оптимизация**: дружественные URL и метатеги- 🌐 **SEO-оптимизация**: дружественные URL и метатеги
|
||||
|
||||
- 🚀 **Высокая производительность**: быстрая загрузка и отзывчивость- 🚀 **Высокая производительность**: быстрая загрузка и отзывчивость
|
||||
|
||||
- 🐳 **Docker Ready**: простой деплой с помощью контейнеров- 🐳 **Docker Ready**: простой деплой с помощью контейнеров
|
||||
- Docker и Docker Compose
|
||||
- Make (для удобства)
|
||||
- Git
|
||||
|
||||
|
||||
|
||||
## 🚀 Быстрый старт## 🚀 Быстрый старт
|
||||
### Установка
|
||||
|
||||
1. **Клонируйте репозиторий**
|
||||
```bash
|
||||
|
||||
|
||||
### Требования### Требования
|
||||
|
||||
- Docker и Docker Compose- Docker и Docker Compose
|
||||
|
||||
- Make (для удобства)- Make (для удобства)
|
||||
|
||||
- Git- Git
|
||||
|
||||
|
||||
|
||||
### Установка### Установка
|
||||
|
||||
|
||||
|
||||
1. **Клонируйте репозиторий**1. **Клонируйте репозиторий**
|
||||
|
||||
```bash ```bash
|
||||
|
||||
git clone https://github.com/smartsoltech/links.git git clone https://github.com/smartsoltech/links.git
|
||||
|
||||
cd links cd links
|
||||
|
||||
``` ```
|
||||
git clone https://github.com/smartsoltech/links.git
|
||||
cd links
|
||||
```
|
||||
|
||||
|
||||
|
||||
@@ -88,79 +72,77 @@
|
||||
|
||||
|
||||
|
||||
### Альтернативная установка (без Make)### Альтернативная установка (без Make)
|
||||
### Альтернативная установка (без Make)
|
||||
```bash
|
||||
|
||||
```bash```bash
|
||||
# Копируйте пример конфигурации
|
||||
|
||||
# Копируйте пример конфигурации# Копируйте пример конфигурации
|
||||
|
||||
cp .env.example .envcp .env.example .env
|
||||
cp .env.example .en
|
||||
|
||||
|
||||
|
||||
# Отредактируйте .env файл# Отредактируйте .env файл
|
||||
# Отредактируйте .env файл
|
||||
|
||||
nano .envnano .env
|
||||
nano .env
|
||||
|
||||
|
||||
|
||||
# Запустите контейнеры# Запустите контейнеры
|
||||
# Запустите контейнеры
|
||||
|
||||
docker-compose up -d --builddocker-compose up -d --build
|
||||
docker-compose up -d --build
|
||||
|
||||
|
||||
|
||||
# Примените миграции# Примените миграции
|
||||
# Примените миграции
|
||||
|
||||
docker-compose exec web python manage.py migratedocker-compose exec web python manage.py migrate
|
||||
docker-compose exec web python manage.py migrate
|
||||
|
||||
|
||||
|
||||
# Создайте суперпользователя# Создайте суперпользователя
|
||||
# Создайте суперпользователя
|
||||
|
||||
docker-compose exec web python manage.py createsuperuserdocker-compose exec web python manage.py createsuperuser
|
||||
docker-compose exec web python manage.py createsuperuser
|
||||
|
||||
``````
|
||||
```
|
||||
|
||||
|
||||
|
||||
## 📋 Управление с помощью Make## 📋 Управление с помощью Make
|
||||
## 📋 Управление с помощью Make
|
||||
|
||||
|
||||
|
||||
Проект включает мощный Makefile для упрощения разработки:Проект включает мощный Makefile для упрощения разработки:
|
||||
Проект включает мощный Makefile для упрощения разработки:
|
||||
|
||||
|
||||
|
||||
```bash```bash
|
||||
|
||||
make help # Показать все доступные командыmake help # Показать все доступные команды
|
||||
make help # Показать все доступные команды
|
||||
|
||||
make dev-bg # Запуск для разработки в фонеmake dev-bg # Запуск для разработки в фоне
|
||||
make dev-bg # Запуск для разработки в фоне
|
||||
|
||||
make status # Проверить статус сервисовmake status # Проверить статус сервисов
|
||||
make status # Проверить статус сервисов
|
||||
|
||||
make health # Проверить работоспособностьmake health # Проверить работоспособность
|
||||
make health # Проверить работоспособность
|
||||
|
||||
make logs # Просмотр логовmake logs # Просмотр логов
|
||||
make logs # Просмотр логов
|
||||
|
||||
make migrate-full # Выполнить миграции и собрать статикуmake migrate-full # Выполнить миграции и собрать статику
|
||||
make migrate-full # Выполнить миграции и собрать статику
|
||||
|
||||
make backup # Создать бэкап базы данныхmake backup # Создать бэкап базы данных
|
||||
make backup # Создать бэкап базы данных
|
||||
|
||||
``````
|
||||
```
|
||||
|
||||
|
||||
|
||||
📖 **[Полное руководство по Makefile](./docs/MAKEFILE.md)**📖 **[Полное руководство по Makefile](./docs/MAKEFILE.md)**
|
||||
📖 **[Полное руководство по Makefile](./docs/MAKEFILE.md)**
|
||||
|
||||
|
||||
|
||||
## 🏗️ Архитектура## 🏗️ Архитектура
|
||||
## 🏗️ Архитектура
|
||||
|
||||
|
||||
|
||||
### Технологический стек### Технологический стек
|
||||
### Технологический стек
|
||||
|
||||
- **Frontend**: Next.js 15, React, TypeScript, Bootstrap 5
|
||||
|
||||
|
||||
Reference in New Issue
Block a user