Добавил доку в md

simvolice · Mar 11, 2018 · 0f69d06 · 0f69d06
1 parent 50887a9
commit 0f69d06
Show file tree

Hide file tree

Showing 5 changed files with 30 additions and 31 deletions.
diff --git a/.forestry/front_matter/templates/.yml b/.forestry/front_matter/templates/.yml
diff --git a/.forestry/settings.yml b/.forestry/settings.yml
diff --git a/_drafts/_pages/.md b/_drafts/_pages/.md
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/index.md b/docs/index.md
@@ -0,0 +1,30 @@
+# Документация разработчика
+
+# Общее описание проекта:
+Проект "akimatCMS", предназначен для загрузки сырых данных в базу MSSQL и дальнейшего его анализа в системе PowerBI, а также дальнейшего отображения готовых диаграмм в CMS.
+
+# Используемый стэк технологий:
+### Серверная сторона:
+* NodeJS - серверная платформа;
+* ExpressJS - специальный фреймверк для построения гибких серверных приложений;
+* JSONWEBTOKEN стандарт -  используется для создания и контроля пользовательских сессий;
+* MongoDB - в качестве основной базы данных для работы CMS;
+* Microsoft Server Express - для хранения плоских excel файлов, в качестве WareHouse;
+* Язык программирования - JavaScript версия ES6.
+### Клиентская сторона:
+* AngularJS v 1.6 - специальный фреймверк для построения клиентских приложений;
+* Twitter Bootstrap сетка - стандартный фреймверк для построения сетки при верстки пользовательского интерфейса;
+* языки программирования и разметки: JavaScript, HTML5, CSS3
+
+# Архитектура серверной части:
+### Структура папок:
+* ` - akimatCMS - главная папка приложения; `
+    *    `- bin - главная входная точка приложения; `
+    * `   - routes - все API точки приложения;`
+    * `   - service - сервисы по работе с базой данных;`
+    * `   - utils - вспомогательные функции для работы приложения;`
+    * `   - public - вся клиентская часть приложения;`
+    * `   - .env - файл конфигурации всего приложения (переменные системы);`
+    * `   - app.js - файл для первого запуска приложения, инициализация первых данных, настройка всего окружения;`
+    * `   - package.json - файл проекта, содержит в себе все зависимости проекта, которые необходимы для работы проекта;`
+