Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/shogowada/null-to-engineer

Last synced: about 1 month ago
JSON representation

Host: GitHub
URL: https://github.com/shogowada/null-to-engineer
Owner: shogowada
Created: 2021-06-18T12:22:11.000Z (over 3 years ago)
Default Branch: main
Last Pushed: 2023-02-11T20:41:13.000Z (almost 2 years ago)
Last Synced: 2024-10-12T16:14:54.774Z (2 months ago)
Language: TypeScript
Homepage: https://web.null-to.engineer
Size: 431 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # null-to-engineer

経験ゼロからソフトウェアエンジニアを目指す人に向けたチュートリアル、[経験ゼロからエンジニア](https://web.null-to.engineer)のソースコードです 🎉

## 構造

| 場所                               | 役割                                                 |

| ---------------------------------- | ---------------------------------------------------- |

| [`./features`](./features)         | E2e テストシナリオ                                   |

| [`./imgs`](./imgs)                 | イメージファイル                                     |

| [`./instructions`](./instructions) | 記事                                                 |

| [`./src/client`](./src/client)     | クライアントコード                                   |

| [`./src/server`](./src/server)     | サーバーコード                                       |

| [`./src/test`](./src/test)         | E2e テストコード                                     |

| [`./src/common`](./src/common)     | クライアント、サーバー、e2e テストで共有されるコード |

## 記事

記事は[`./instructions`](./instructions)に Markdown としてまとめられています。

サーバーは実行時に全ての記事を HTML へと変換します。HTML は API を通じて、必要なときに必要な分だけクライアントに渡されます。

## アクセス分析

アクセス分析には [Plausible](https://plausible.io) を使っています。

[`./index.template.html`](./index.template.html) にスクリプトを注入しています。

## 開発

### 環境

ビルド・実行・テストは Docker 上で行う。それぞれ NPM コマンドから走らせられるようになっています。

- [NPM](https://nodejs.org/en/)

- [Docker](https://docs.docker.com/get-docker/)

- [Docker Compose](https://docs.docker.com/compose/install/)

### 実行

Docker イメージをビルドし、走らせます。

1. `npm start`

### テスト

#### ユニットテスト

ユニットテストはビルド中に走ります。`<ターゲット>.spec.ts`という名前で、テストターゲットと同じフォルダに置いてください。

#### E2e テスト

E2e テストシナリオは[`./features`](./features)に、コードは[`./src/test`](./src/test)にまとめられています。

中身は Cucumber と Selenium。

ターゲットが API の場合は`@api`タグを、GUI の場合は`@gui`タグが必要。もちろん、両方つけることもできます。

API テストのコードは[`./src/test/api`](./src/test/api)に、GUI テストのコードは[`./src/test/gui`](./src/test/gui)にあります。

以下のコマンドで走ります。

1. `npm test`

以下のコマンドで、`@wip`タグをつけたテストだけ走らすことができます。いくつかのテストシナリオだけに集中したい場合に便利 👍

1. `npm run test-wip`