Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/assapir/story-line

Last synced: about 2 months ago
JSON representation

Host: GitHub
URL: https://github.com/assapir/story-line
Owner: assapir
License: mit
Created: 2019-06-05T17:30:58.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2023-01-07T07:24:14.000Z (about 2 years ago)
Last Synced: 2023-03-05T19:04:02.113Z (almost 2 years ago)
Language: TypeScript
Size: 3.26 MB
Stars: 2
Watchers: 3
Forks: 4
Open Issues: 70
Metadata Files:
- Readme: readme.md
- License: LICENSE

Awesome Lists containing this project

README

        # story-line

## Many lines becomes a story

![Build](https://github.com/assapir/story-line/workflows/docker-build/badge.svg) [![Coverage Status](https://coveralls.io/repos/github/assapir/story-line/badge.svg?branch=master)](https://coveralls.io/github/assapir/story-line?branch=master) [![Known Vulnerabilities](https://snyk.io//test/github/assapir/story-line/badge.svg?targetFile=api/package.json)](https://snyk.io//test/github/assapir/story-line?targetFile=api/package.json) [![Last commit](https://img.shields.io/github/last-commit/meijin007/story-line.svg)](https://github.com/meijin007/story-line/commits/master) ![GitHub contributors](https://img.shields.io/github/contributors-anon/meijin007/story-line.svg) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/3c0cbc240e8b405ba0b93113f8aae62f)](https://app.codacy.com/app/meijin007/story-line?utm_source=github.com&utm_medium=referral&utm_content=meijin007/story-line&utm_campaign=Badge_Grade_Dashboard)


 

![GitHub](https://img.shields.io/github/license/meijin007/story-line.svg?color=blue) ![GitHub top language](https://img.shields.io/github/languages/top/meijin007/story-line.svg) [![lerna](https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg)](https://lerna.js.org/) ![Assaf Badges](https://img.shields.io/badge/Assaf-Like%20badges-blue.svg) 

## 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]([https://typeorm.io/]) 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](https://coveralls.io/github/meijin007/story-line).

## General

### Creating migration

    npm run typeorm migration:generate -- -n NameOfMigration


 

Ⓒ Created By Assaf Sapir, 2019, Under MIT License