Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/haba-kudzaev/rx1310.site
👨💻 Персональный сайт @rx1310, на котором размещены все основные проекты, резюме и визитка
https://github.com/haba-kudzaev/rx1310.site
11ty js markdown njk rx1310 sass
Last synced: 1 day ago
JSON representation
👨💻 Персональный сайт @rx1310, на котором размещены все основные проекты, резюме и визитка
- Host: GitHub
- URL: https://github.com/haba-kudzaev/rx1310.site
- Owner: haba-kudzaev
- License: apache-2.0
- Archived: true
- Created: 2021-12-27T16:54:25.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2022-08-05T02:38:50.000Z (about 2 years ago)
- Last Synced: 2024-09-22T12:31:46.483Z (6 days ago)
- Topics: 11ty, js, markdown, njk, rx1310, sass
- Language: Nunjucks
- Homepage: https://rx1310.github.io/
- Size: 674 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
[rx1310.github.io](https://rx1310.github.io)
======
Репозиторий с исходным кодом персонального сайта Асхаба Кудзаева (rx1310).
[](https://app.netlify.com/sites/rx1310/deploys)
[
](https://github.com/rx1310/rx1310.github.io/pulls)
## 📥 Клонирование репозитория
Для клонирования репозитория необходимо иметь установленный [Git](https://git-scm.com/downloads).
1. Клонирование репозитория выполняется командой в терминале:
```bash
git clone https://github.com/rx1310/rx1310.github.io.git
```
> Если используется SSH, то:
> ```bash
> git clone [email protected]:rx1310/rx1310.github.io.git
> ```
> Если используется [GitHub CLI](https://cli.github.com/)
> ```bash
> gh repo clone rx1310/rx1310.github.io
> ```
2. Переходим в основную ветку для разработки ([develop](https://github.com/rx1310/rx1310.github.io/tree/develop))
```bash
git checkout develop
```
3. Готово!
## 📁 О ветках в репозитории
В репо есть три основных ветки:
| Ветка | Краткое описание |
| ------------ | ---------------- |
| [develop](https://github.com/rx1310/rx1310.github.io/tree/develop) | используется для разработки |
| [main](https://github.com/rx1310/rx1310.github.io/tree/main) | ветка для окончательной версии |
| [redirect](https://github.com/rx1310/rx1310.github.io/tree/redirect) | не используется в разработке и предназначен только для [редиректа](https://github.com/rx1310/rx1310.github.io/blob/redirect/index.html) с GH Pages на основной [домен](https://rx1310.site).
## 📦 Сборка проекта
Сборкой проекта занимается генератор статики [Eleventy](https://github.com/11ty). Скрипты для сборки и разработки прописаны в файле [package.json](package.json).
Команды npm прописываются в терминале:
```bash
npm run <команда>
```
Вот список доступных команд для разработки:
| Команда | Что делает? |
| ------------:|:----------------------------------- |
| `start` | запускает сервер 11ty и вотчер SASS |
| `build` | запускает сборку 11ty и SASS |
| `11ty:serve` | запускает сервер 11ty (BrowserSync) |
| `11ty:build` | собирает 11ty (шаблоны и тп.) |
| `sass:watch` | запускает вотчер SASS |
| `sass:build` | собирает SASS в CSS |
## 🔧 Инструментарий
В этом пункте расписаны те инструменты, которые используются непосредственно для разработки.
### Среда разработки
Разработка проекта ведется в редакторе кода [Visual Studio Code](https://code.visualstudio.com/), для которого уже прописаны все необходимые для проекта конфиги в папке [.vscode](.vscode/).
```
.vscode/
├── extensions.json (рекомендуемые расширения для VSCode)
├── other.code-snippets (прочие сниппеты)
├── sass.code-snippets (сниппеты для SASS)
└── settings.json (настройки проекта для редактора)
```
По умолчанию в редакторе скрыты некоторые маловажные папки и файлы. Настроить их отображение можно в файле [.vscode/settings.json](.vscode/settings.json):
```json
"files.exclude": {
"dist/" : false,
".github/" : true,
"node_modules" : true,
".ecrc" : true,
".editorconfig" : true,
".eleventyignore": true,
"package-lock.*" : true,
".gitignore" : true,
"LICENSE" : true
},
```
> Если значение `true` - скрыто, если `false` - не скрыто, что логично.
### NodeJS и npm
Необходимо также иметь установленный [NodeJS](https://nodejs.org/en/download/) на компьютере для полноценной работы Eleventy, SASS и других плагинов.
> Менеджер пакетов npm должен сам установиться вместе с NodeJS.
### Eleventy
> [Eleventy](https://www.11ty.dev/) (11ty) — это статический генератор сайтов, который сейчас набирает популярность. Его используют Google, Khan Academy, Netlify и другие.
Конфиги для 11ty находятся в файле [.11ty.js](.11ty.js).
- основная папка (input): [app/](app/)
- папка, в которую собирается проект (output): [dist/](dist/)
- папка с данными (data): [app/data/](app/data/)
```js
dir: {
input: 'app',
output: 'dist',
includes: 'includes/',
layouts: 'layouts/',
data: "data"
},
```
## 📃 Лицензия проекта
Проект [rx1310.github.io](https://github.com/rx1310/rx1310.github.io) распространяется совершенно бесплатно и находится под защитой лицензии [Apache-2.0](LICENSE).
Инструментарий, используемый в разработке, распространяется по указанной автором / компанией / разработчиком лицензии, не зависящей от этого проекта.
```
Apache License, Version 2.0
Copyright 2022 Haba Kudzaev (rx1310)
```
> Если Вы нашли нарушение чьей-либо лицензии в моем проекте, то просьба написать мне → [Telegram](https://t.me/rx1310), [эл. почта](mailto:[email protected]) или [VK](https://vk.com/rx1310).