Init

Author: NovoManu

.gitignore

@@ -1,7 +1,4 @@
-.DS_Store
+# IDE settings
 .idea
-.vscode
-node_modules
-npm-debug.log
-Thumbs.db
-todo.md
+.DS_Store
+*/.DS_Store

Makefile

@@ -0,0 +1,35 @@
+# Makefile for local development
+
+rebuild_backend:
+	docker-compose down -v
+	docker-compose run backend npm run rebuild
+
+start_project:
+	docker-compose down -v
+	docker-compose up --build
+
+run_server:
+	docker-compose down -v
+	docker-compose up backend --build
+
+run_tests:
+	cd frontend; echo "...Starting frontend tests" && \
+	npm run test:unit
+
+run_template:
+	cd template; echo "...Starting frontend tests" && \
+	npm start
+
+install_backend_dependencies:
+	cd backend; echo "...Installing server dependencies" && \
+	npm install
+
+install_frontend_dependencies:
+	cd frontend; echo "...Installing client dependencies" && \
+	npm install
+
+install_template_dependencies:
+	cd template; echo "...Installing template dependencies" && \
+	npm install
+
+install_dependencies: install_backend_dependencies install_frontend_dependencies install_template_dependencies

README.md

@@ -1,2 +1,187 @@
-# vue-third-work-start-source
-Исходники курса «Vue 3» Work
+# HTML Academy. Учебный проект «VueWork»
+
+## Начальные требования
+- Docker
+- Docker-compose
+- NodeJS >= 16
+
+## Docker установка
+https://docs.docker.com/get-docker/
+
+https://dker.ru/docs/ (рус)
+
+## Docker-compose установка
+https://docs.docker.com/compose/install/
+
+## Node js установка
+Мы рекоммендуем использовать Node Version Manager для удобного управления версиями node.js
+
+https://github.com/nvm-sh/nvm
+
+Либо можно установить node.js отдельно
+
+https://nodejs.org/en/download/
+
+## Работа с помощью GNU Make
+Для удобной работой с проектом мы используем GNU Make.
+
+https://www.gnu.org/software/make/
+
+По-умолчанию, GNU Make уже предустановлен на Unix операционных системах.
+Чтобы проверить установлени ли GNU Make на вашем компьютере выполните команду в терминале
+
+```
+make --version 
+```
+
+В случае отстутствия GNU Make, мы рекоммендуем установить его.
+
+В makefile доступны следующие команды
+
+Установить зависимости для проекта
+
+`$ make install_dependencies`
+
+Запустить проект
+
+`$ make start_project`
+
+## Работа без GNU Make
+
+### Frontend установка
+
+- Перейдите в директорию (выполнить из корня приложения)
+
+`cd frontend`
+
+- Установите зависимости
+
+`$ npm install`
+
+В директории `src/frontend` возможно выполнить следующие скрипты:
+
+```
+npm run serve - запуск проекта (только клиент) в режиме разработки
+npm run build - создание продакшн сборки проекта
+npm run test:unit - запуск юнит тестов
+npm run lint - запуск линтера
+```
+
+### Backend установка
+
+- Перейдите в директорию (выполнить из корня приложения)
+
+`cd backend`
+
+- Установите зависимости
+
+`$ npm install`
+
+- Запуск сервера (для запуска необходима работающая база данных на порте :5432)
+
+`$ npm start`
+
+### Установка шаблона
+
+- Перейдите в директорию (выполнить из корня приложения)
+
+`cd template`
+
+- Установите зависимости
+
+`$ npm install`
+
+- Запуск шаблонов
+
+`$ npm start`
+
+### Docker настройка
+
+- Сборка проекта
+
+`$ docker-compose build`
+
+### Запуск проекта с Docker
+
+`$ docker-compose down -v`
+
+`$ docker-compose up`
+
+Сервер будет доступен по адресу `localhost:3000`
+
+Клиент будет доступен по адресу `localhost:8080`
+
+### Запуск проекта без Docker
+
+| Внимание: требуется ручной запуск базы данных |
+|-----------------------------------------------|
+
+- Запуск базы данных
+
+Запустите PostgreSQL базу данных
+
+Обновите конфигурацию подключения базы данных для сервера в файле `backend/src/datasources/database.datasource.ts`
+
+- Запуск сервера (выполнить из корня приложения)
+
+```
+cd backend && npm start
+```
+
+- Запуск клиента (выполнить из корня приложения)
+
+```
+cd frontend && npm run dev
+```
+
+Сервер будет доспупен по адресу `localhost:3000`
+
+Клиент будет доспупен по адресу `localhost:8080`
+
+
+## Вход в приложение
+
+Мы подготовили несколько готовых пользователей в базе данных.
+Список пользователей, электронные почты и пароли для входа доступны здесь
+```
+src/backend/src/factory/dummy-users.json
+```
+
+## API документация (OpenAPI)
+Документация доступна по адресу
+
+```
+http://localhost:3000/explorer/
+```
+
+## Запуск и просмотр готовой верстки проекта
+
+### С помощью GNU Make
+
+`$ make install_template_dependencies`
+
+`$ make run_template`
+
+### Без GNU Make
+
+Перейдите в директорию template:
+
+```
+cd template 
+```
+
+Установите зависимости, выполнив команду:
+
+```
+npm install
+```
+
+Запустите проект командой:
+
+```
+npm start
+```
+
+Шаблон и вёрстка будут доступны по адресу: `http://localhost:9999`.
+
+Вёрстку можно посмотреть в директории `template/src`.

backend/.dockerignore

@@ -0,0 +1,5 @@
+node_modules
+npm-debug.log
+/dist
+# Cache used by TypeScript's incremental build
+*.tsbuildinfo

backend/.eslintignore

@@ -0,0 +1,4 @@
+node_modules/
+dist/
+coverage/
+.eslintrc.js

backend/.eslintrc.js

@@ -0,0 +1,7 @@
+module.exports = {
+  extends: '@loopback/eslint-config',
+  "parserOptions":
+    {
+      "ecmaVersion": 2020
+    }
+};

backend/.gitignore

@@ -0,0 +1,64 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (http://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Typescript v1 declaration files
+typings/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+
+# Transpiled JavaScript files from Typescript
+/dist
+
+# Cache used by TypeScript's incremental build
+*.tsbuildinfo

backend/.npmrc

@@ -0,0 +1,2 @@
+package-lock=true
+scripts-prepend-node-path=true

backend/.prettierignore

@@ -0,0 +1,2 @@
+dist
+*.json

backend/.prettierrc

@@ -0,0 +1,7 @@
+{
+  "bracketSpacing": false,
+  "singleQuote": true,
+  "printWidth": 80,
+  "trailingComma": "all",
+  "arrowParens": "avoid"
+}

backend/.yo-rc.json

@@ -0,0 +1,6 @@
+{
+  "@loopback/cli": {
+    "packageManager": "npm",
+    "version": "2.15.1"
+  }
+}

backend/DEVELOPING.md

@@ -0,0 +1,36 @@
+# Developer's Guide
+
+We use Visual Studio Code for developing LoopBack and recommend the same to our
+users.
+
+## VSCode setup
+
+Install the following extensions:
+
+- [eslint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
+- [prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)
+
+## Development workflow
+
+### Visual Studio Code
+
+1. Start the build task (Cmd+Shift+B) to run TypeScript compiler in the
+   background, watching and recompiling files as you change them. Compilation
+   errors will be shown in the VSCode's "PROBLEMS" window.
+
+2. Execute "Run Rest Task" from the Command Palette (Cmd+Shift+P) to re-run the
+   test suite and lint the code for both programming and style errors. Linting
+   errors will be shown in VSCode's "PROBLEMS" window. Failed tests are printed
+   to terminal output only.
+
+### Other editors/IDEs
+
+1. Open a new terminal window/tab and start the continuous build process via
+   `npm run build:watch`. It will run TypeScript compiler in watch mode,
+   recompiling files as you change them. Any compilation errors will be printed
+   to the terminal.
+
+2. In your main terminal window/tab, run `npm run test:dev` to re-run the test
+   suite and lint the code for both programming and style errors. You should run
+   this command manually whenever you have new changes to test. Test failures
+   and linter errors will be printed to the terminal.