Git Product home page Git Product logo

hajs's Introduction

HA.JS

Фреймворк для создания REST-API. Данный проект построен на базе курса «Node.js. Профессиональная разработка REST API» HTML Академии.

Особенности фреймворка

  • Создание адаптированных REST API для учебных проектов;
  • Полная типизация проекта;
  • Хранение данных в памяти;
  • Использование внедрения зависимостей (DI);
  • Использование ES-модулей (CommonJs не поддерживается).

Принципы фреймворка

  • Разделение ответственности на слои приложения;
  • Стандартизация движения данных между слоями (DTO, RDO, Entity);
  • Все что должно быть типизировано, должно быть типизировано.

Сборка проекта

npm run build

Запуск тестов

npm run test

Линтинг кода

npm run lint

Документация

Документацию вы можете найти по следующей ссылке

Использование

import { LoggerInterface } from '.../hajs/common';

class Service {
  public loggerService!: LoggerInterface;

  constructor(logger: LoggerInterface) {
    this.loggerService = logger;
  }

  public init() {
    this.loggerService.info('Initialize Service');
  }
}

Внесение изменений

  • Клонируй / обнови актульную версию репозитория

    git clone [email protected]:kam4atka/hajs.git
    
    # or
    
    cd ./hajs
    git pull origin main
  • Создай новую ветку для внесения изменений.

    Обрати внимание:

    • именование веток и коммитов следует формулировать согласно соглашения о именовании
    • коммиты не следует делать большими. С большими коммитами не удобно проводить ревью кода
    # .../hajs
    
    git checkout -b fix/update-tests-for-database-service
  • После внесения изменений отправь созданную ветку в репозиторий и создай Pull Request

    # .../hajs
    
    git push origin fix/update-tests-for-database-service
  • После ревью Pull Request слей Pull Request с веткой main с объединением коммитов (Squash and merge)

hajs's People

Contributors

kam4atka avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.