Skip to content

Latest commit

 

History

History
41 lines (27 loc) · 2.22 KB

readme.md

File metadata and controls

41 lines (27 loc) · 2.22 KB

story-line

Many lines becomes a story

Build Coverage Status Known Vulnerabilities Last commit GitHub contributors Codacy Badge
GitHub GitHub top language lerna Assaf Badges

Monorepo Architecture

  • /api is for the backend.
  • /ui is for the front end
  • TODO: Create docker / docker compose for running

Backend Architecture

  • Heavily use of Dependency Injection (without any framework).
  • Express.js Controllers accepting a
  • Service which is in abstract on the
  • Model which is defined using TypeORM as ORM.
    • Currently using Sqlite3.

UI

  • React
  • MaterialUI

Tests

  • Every testable class under src/ should have a corresponding test suit file in test/.
  • run npm run test to run all the tests with coverage information.
  • CI (Travis) should run npm run test:ci for sending coverage data to coveralls.io.

General

Creating migration

npm run typeorm migration:generate -- -n NameOfMigration

Ⓒ Created By Assaf Sapir, 2019, Under MIT License