Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/kato83/knowledge-note

JSベースでQiitaライクなアプリケーションを作成しよう(専門学生向け)
https://github.com/kato83/knowledge-note

Last synced: 24 days ago
JSON representation

JSベースでQiitaライクなアプリケーションを作成しよう(専門学生向け)

Awesome Lists containing this project

README

        

# 模擬的に技術共有サイト "Knowledge note" をイチから実装してみよう

技術系ナレッジ共有サイトを参考に設計からJSベースの開発までを実際にやってみよう。

## 参考とするサイト

- [Zenn|エンジニアのための情報共有コミュニティ](https://zenn.dev/)
- [Qiita](https://qiita.com/)

## 注意事項

> [!CAUTION]
> 本番運用を想定していません、当リポジトリの実装では技術の活用と理解を深めるのを目的としたものであり、いくつかの脆弱性の対策が施されていない状態となっています。

## 当授業での狙い

プログラムの基礎にはフォーカスを当てず、今後開発するうえで絶対に起こり得る、以下のような「未知との遭遇」に対処できるようになります。

- 今までに見たことのないエラー
- 今までに使ったことのないライブラリ
- 今までに見たことのない記法

主体的に情報収集してトラブルシュート能力やドキュメント等のキャッチアップする能力を鍛えることを目的としています。

## セットアップ

まずは当リポジトリをあなたのリポジトリにインポートするところから始めてください。

インポート対象のリポジトリ: https://github.com/kato83/knowledge-note.git

インポート方法の参考: [GitHub Importer でリポジトリをインポートする - GitHub Docs](https://docs.github.com/ja/migrations/importing-source-code/using-github-importer/importing-a-repository-with-github-importer)

インポートしたリポジトリにて Codespace を起動し、以下の操作を実行してください。

### バックエンド (backend/)

```sh
$ cd ./backend
$ npm install
$ npm run prisma:generate
$ npm run prisma:migrate
$ npm run dev
```

サーバーが立ち上がるので動作しているかを以下パスで確認してください。

- https://[GitHub codespaceのプレビューURL]/api/v1
- https://[GitHub codespaceのプレビューURL]/api/docs

### フロントエンド(frontend/)

```sh
$ cd ./frontend
$ npm install
$ npm run dev
```

サーバーが立ち上がるので動作しているかを以下パスで確認してください。

- https://[GitHub codespaceのプレビューURL]/
- https://[GitHub codespaceのプレビューURL]/api/v1
- https://[GitHub codespaceのプレビューURL]/api/docs