docs: init golang/nodejs architecture
This commit is contained in:
parent
dd09dd1e91
commit
865ae890bb
94
README.md
94
README.md
@ -1,92 +1,6 @@
|
||||
# docs
|
||||
# Общая документация по сервисам/микросервисам
|
||||
|
||||
## Архитектура:
|
||||
|
||||
|
||||
## Getting started
|
||||
|
||||
To make it easy for you to get started with GitLab, here's a list of recommended next steps.
|
||||
|
||||
Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
|
||||
|
||||
## Add your files
|
||||
|
||||
- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
|
||||
- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
|
||||
|
||||
```
|
||||
cd existing_repo
|
||||
git remote add origin https://penahub.gitlab.yandexcloud.net/pena-services/docs.git
|
||||
git branch -M main
|
||||
git push -uf origin main
|
||||
```
|
||||
|
||||
## Integrate with your tools
|
||||
|
||||
- [ ] [Set up project integrations](https://penahub.gitlab.yandexcloud.net/pena-services/docs/-/settings/integrations)
|
||||
|
||||
## Collaborate with your team
|
||||
|
||||
- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
|
||||
- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
|
||||
- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
|
||||
- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
|
||||
- [ ] [Automatically merge when pipeline succeeds](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
|
||||
|
||||
## Test and Deploy
|
||||
|
||||
Use the built-in continuous integration in GitLab.
|
||||
|
||||
- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
|
||||
- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing(SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
|
||||
- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
|
||||
- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
|
||||
- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
|
||||
|
||||
***
|
||||
|
||||
# Editing this README
|
||||
|
||||
When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thank you to [makeareadme.com](https://www.makeareadme.com/) for this template.
|
||||
|
||||
## Suggestions for a good README
|
||||
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
|
||||
|
||||
## Name
|
||||
Choose a self-explaining name for your project.
|
||||
|
||||
## Description
|
||||
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
|
||||
|
||||
## Badges
|
||||
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
|
||||
|
||||
## Visuals
|
||||
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
|
||||
|
||||
## Installation
|
||||
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
|
||||
|
||||
## Usage
|
||||
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
|
||||
|
||||
## Support
|
||||
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
|
||||
|
||||
## Roadmap
|
||||
If you have ideas for releases in the future, it is a good idea to list them in the README.
|
||||
|
||||
## Contributing
|
||||
State if you are open to contributions and what your requirements are for accepting them.
|
||||
|
||||
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
|
||||
|
||||
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
|
||||
|
||||
## Authors and acknowledgment
|
||||
Show your appreciation to those who have contributed to the project.
|
||||
|
||||
## License
|
||||
For open source projects, say how it is licensed.
|
||||
|
||||
## Project status
|
||||
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
|
||||
- [**Архитектура сервисов NodeJS**](./architecture/nodejs/README.md)
|
||||
- [**Архитектура сервисов Golang**](./architecture/golang/README.md)
|
||||
|
82
architecture/golang/README.md
Normal file
82
architecture/golang/README.md
Normal file
@ -0,0 +1,82 @@
|
||||
# Архитектура сервиса/микросервиса на Golang
|
||||
|
||||
## Основа:
|
||||
|
||||
```
|
||||
├── cmd - Основные приложения проекта
|
||||
├── deployments - Директория для деплоя сервиса
|
||||
├── docs - Директория с документация
|
||||
├── internal - Директория с внутренним кодом приложения
|
||||
├── pkg - Директория с общими модулями приложения
|
||||
├── .gitignore - Файл для перечисления игнорирования гита
|
||||
├── .gitlab-ci.yml - Файл настройки Gitlab CI
|
||||
├── Makefile - Набор команд
|
||||
├── Dockerfile - Файл контейнеризации сервиса
|
||||
├── README.md - Общий файл документации (путеводитель)
|
||||
├── go.mod - Корень управления зависимостями в GoLang
|
||||
├── go.sum - Файл содержащий хеши для нескольких версий модуля
|
||||
```
|
||||
|
||||
## Структура `/cmd`:
|
||||
|
||||
```
|
||||
├── [app name] - Название приложения (app)
|
||||
│ ├── main.go - Точка входа в приложение
|
||||
```
|
||||
|
||||
## Структура `/docs`:
|
||||
|
||||
```
|
||||
├── [group] - Группа документации
|
||||
│ ├── README.md - Файл документации
|
||||
```
|
||||
|
||||
## Структура `/internal`:
|
||||
|
||||
Здесь хранится внутренний код приложения и библиотек. Это код, который не должен быть применен в других приложениях и библиотеках. Стоит отметить, что этот шаблон навязан самим компилятором Golang. Ознакомьтесь с release notes Go 1.4. Также, вы вольны использовать internal директорию на разных уровнях своего проекта.
|
||||
|
||||
```
|
||||
├── app - Пакет приложений
|
||||
│ ├── [app name].go - Приложение
|
||||
│ ├── [other helpers].go - Различные функции/утилиты для запуска приложений (graceful shutdown)
|
||||
├── client - Пакет клиента для взаимодействия с другими сервисами
|
||||
│ ├── [name].go - Сам клиент
|
||||
│ controller - Пакет контроллеров для хранящий обработчики по каждому роуту
|
||||
│ ├── [name].go - Сам контроллер
|
||||
├── errors - Пакет, хранящий обобщённые ошибки в отдельном файле
|
||||
│ ├── [name].go - Группа ошибок, например: ошибки репозитория (repository.go)
|
||||
├── initialize - Пакет для инициализации разных сущностей (контроллеров, репозиториев, клиентов)
|
||||
│ ├── [name].go - Инициализция сущности, например: композита репозиториев (repository.go)
|
||||
├── models - Пакет моделей данных
|
||||
│ ├── [name].go - Набор моделей, например: user.go
|
||||
├── repository - Пакет репозиториев для взаимодействия с базой данных
|
||||
│ ├── [name].go - Методы репозитория, например: user.go
|
||||
├── server - Пакет хранящий инициализации серверов (http/tcp/grpc)
|
||||
│ ├── [name].go - Файл инициализации сервера (http/tcp/grpc)
|
||||
├── utils - Пакет внутренних функций/утилит приложения
|
||||
│ ├── [name].go - Утилита
|
||||
```
|
||||
|
||||
## Структура `/pkg`:
|
||||
|
||||
Код библиотек, пригодных для использования в сторонних приложениях. (например, `/pkg/mypubliclib`). Другие проекты будут импортировать эти библиотеки, ожидая их автономной работы, поэтому стоит подумать дважды, прежде чем класть сюда какой-нибудь код. Использование директории `internal` - более оптимальный способ не дать импортировать внутренние пакеты, потому что это обеспечит сам `Golang`. Директория `/pkg` - всё еще хороший путь дать понять, что код в этой директории могут безопасно использовать другие.
|
||||
|
||||
Код из директории `/pkg` желательно в будущем выносить в отдельный репозиторий общих пакетов.
|
||||
|
||||
```
|
||||
├── utils - Пакет утилит, доступные разным приложениям
|
||||
│ ├── [name].go - Утилита
|
||||
```
|
||||
|
||||
## Тесты:
|
||||
|
||||
В каждом пакете присутствует файл, хранящий выполняемый код, рядом с этим файлом должен находится файл тестов, которые будет содержать имя этого файла и постфикс `_test`.
|
||||
|
||||
```
|
||||
│ controller - Пакет контроллеров для хранящий обработчики по каждому роуту
|
||||
│ ├── [name].go - Сам контроллер
|
||||
│ ├── [name]_test.go - Файл тестов контроллера
|
||||
├── utils - Пакет внутренних функций/утилит приложения
|
||||
│ ├── [name].go - Утилита
|
||||
│ ├── [name]_test.go - Файл тестов утилиты
|
||||
```
|
69
architecture/nodejs/README.md
Normal file
69
architecture/nodejs/README.md
Normal file
@ -0,0 +1,69 @@
|
||||
# Архитектура сервиса/микросервиса на NodeJS
|
||||
|
||||
## Основа:
|
||||
|
||||
```
|
||||
├── .husky - Директория для git скриптов
|
||||
├── deployments - Директория для деплоя сервиса
|
||||
├── docs - Директория с документация
|
||||
├── src - Директория с кодом проекта
|
||||
├── .commitlintrc.json - Файл настройки для проверки формата коммитов
|
||||
├── .eslintignore - Файл для перечисления игнорирования линтера
|
||||
├── .eslintrc - Файл настройки линтера
|
||||
├── .gitignore - Файл для перечисления игнорирования гита
|
||||
├── .gitlab-ci.yml - Файл настройки Gitlab CI
|
||||
├── .prettierrc - Файл настройки форматтера Prettier
|
||||
├── Dockerfile - Файл контейнеризации сервиса
|
||||
├── jest.config.js - Файл настройки Jest фреймворка для написания тестов
|
||||
├── nodemon.json - Файл настройки nodemon'а
|
||||
├── package.json - Файл настройки проекта
|
||||
├── README.md - Общий файл документации (путеводитель)
|
||||
├── tsconfig.json - Файл настройки typescript'а
|
||||
├── yarn.lock - Файл хранения закреплённых версий загруженных пакетов
|
||||
```
|
||||
|
||||
## Структура `/.husky`:
|
||||
|
||||
```
|
||||
├── _ - Сгенерированные git скрипты
|
||||
├── commit-msg - Настройки скрипта для проверки формата коммита
|
||||
├── pre-commit - Настройки скрипта для выполнения других скриптов перед коммитом
|
||||
```
|
||||
|
||||
## Структура `/docs`:
|
||||
|
||||
```
|
||||
├── [group] - Группа документации
|
||||
│ ├── README.md - Файл документации
|
||||
```
|
||||
|
||||
## Структура `/src`:
|
||||
|
||||
```
|
||||
├── configuration - Директория с модулями для конфигурации сервиса
|
||||
├── constans - Директория констант
|
||||
├── __tests__ - Директория тестов
|
||||
│ ├── [group] - Группа тестов
|
||||
│ │ ├── [name].test.ts - Файл тестов
|
||||
├── __mocks__ - Директория моков
|
||||
│ ├── [name].mocks.ts - Файл моков
|
||||
│ handlers - Директория обработчиков
|
||||
│ ├── [group] - Группа обработчиков
|
||||
│ │ ├── helpers.ts - Различные функции/утилиты для обработчиков
|
||||
│ │ ├── index.ts - Обработчики
|
||||
│ │ ├── middleware.ts - Промежуточные обработчики
|
||||
│ │ ├── types.ts - Все типы и структуры данных, которые касаются только обработчиков этой группы
|
||||
├── models - Все модели MondoDB/PostgreSQL
|
||||
│ ├── [name].model.ts - Файл модели данных
|
||||
├── routes - Директория для роутов, которые по определённому пути назначают обработчик
|
||||
│ ├── [group].routes.ts - Файл роутов
|
||||
├── server - Директория с утилитами основного серверного модуля для запуска и работы сервиса
|
||||
├── swagger - Схема для валидации и генерации документации роутов
|
||||
├── types - Все типы и структуры данных, которые могут использоватся несколькими модулями
|
||||
│ ├── [group] - Группа структур данных и типов
|
||||
│ │ ├── [name].type.ts - Тип / структура данных
|
||||
│ ├── [name].type.ts - Тип / структура данных
|
||||
├── utils - Различные утилиты/функции, которые могут использоваться несколькими модулями
|
||||
│ ├── [name].util.ts - Утилита
|
||||
├── index.ts - Точка входа программы
|
||||
```
|
Loading…
Reference in New Issue
Block a user